Loggly output pluginedit

  • Plugin version: v3.0.1
  • Released on: 2017-06-23
  • Changelog

Getting Helpedit

For questions about the plugin, open a topic in the Discuss forums. For bugs or feature requests, open an issue in Github. For the list of Elastic supported plugins, please consult the Elastic Support Matrix.

Descriptionedit

Ugly monkey patch to get around http://jira.codehaus.org/browse/JRUBY-5529 Got a loggly account? Use logstash to ship logs to Loggly!

This is most useful so you can use logstash to parse and structure your logs and ship structured, json events to your account at Loggly.

To use this, you’ll need to use a Loggly input with type http and json logging enabled.

Loggly Output Configuration Optionsedit

This plugin supports the following configuration options plus the Common Options described later.

Also see Common Options for a list of options supported by all output plugins.

 

can_retryedit

  • Value type is boolean
  • Default value is true

Can Retry. Setting this value true helps user to send multiple retry attempts if the first request fails

hostedit

  • Value type is string
  • Default value is "logs-01.loggly.com"

The hostname to send logs to. This should target the loggly http input server which is usually "logs-01.loggly.com" (Gen2 account). See Loggly HTTP endpoint documentation at https://www.loggly.com/docs/http-endpoint/

keyedit

  • This is a required setting.
  • Value type is string
  • There is no default value for this setting.

The loggly http input key to send to. This is usually visible in the Loggly Inputs page as something like this:

    https://logs-01.loggly.net/inputs/abcdef12-3456-7890-abcd-ef0123456789
                                          ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
                                          \---------->   key   <-------------/

You can use %{foo} field lookups here if you need to pull the api key from the event. This is mainly aimed at multitenant hosting providers who want to offer shipping a customer’s logs to that customer’s loggly account.

protoedit

  • Value type is string
  • Default value is "http"

Should the log action be sent over https instead of plain http

proxy_hostedit

  • Value type is string
  • There is no default value for this setting.

Proxy Host

proxy_passwordedit

  • Value type is password
  • Default value is ""

Proxy Password

proxy_portedit

  • Value type is number
  • There is no default value for this setting.

Proxy Port

proxy_useredit

  • Value type is string
  • There is no default value for this setting.

Proxy Username

retry_countedit

  • Value type is number
  • Default value is 5

Retry count. It may be possible that the request may timeout due to slow Internet connection if such condition appears, retry_count helps in retrying request for multiple times It will try to submit request until retry_count and then halt

tagedit

  • Value type is string
  • Default value is "logstash"

Loggly Tag Tag helps you to find your logs in the Loggly dashboard easily You can make a search in Loggly using tag as "tag:logstash-contrib" or the tag set by you in the config file.

Helpful for leveraging Loggly source groups. https://www.loggly.com/docs/source-groups/

Common Optionsedit

The following configuration options are supported by all output plugins:

Setting Input typeRequired

codec

codec

No

enable_metric

boolean

No

id

string

No

workers

number

No

codecedit

  • Value type is codec
  • Default value is "plain"

The codec used for output data. Output codecs are a convenient method for encoding your data before it leaves the output, without needing a separate filter in your Logstash pipeline.

enable_metricedit

  • Value type is boolean
  • Default value is true

Disable or enable metric logging for this specific plugin instance by default we record all the metrics we can, but you can disable metrics collection for a specific plugin.

  • Value type is string
  • There is no default value for this setting.

Add a unique ID to the plugin configuration. If no ID is specified, Logstash will generate one. It is strongly recommended to set this ID in your configuration. This is particularly useful when you have two or more plugins of the same type, for example, if you have 2 grok filters. Adding a named ID in this case will help in monitoring Logstash when using the monitoring APIs.

output {
 stdout {
   id => "my_plugin_id"
 }
}

workersedit

  • Value type is string
  • Default value is 1