Loggly output plugin v4.0.0

  • Plugin version: v4.0.0
  • Released on: 2018-05-15
  • Changelog

For other versions, see the overview list.

To learn more about Logstash, see the Logstash Reference.

Getting Help

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.

Description

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 Options

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_retry

  • 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

host

  • 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 the Loggly HTTP endpoint documentation.

key

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

The loggly http customer token to use for sending. You can find yours in "Source Setup", under "Customer Tokens".

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.

max_event_size

  • This is a required setting.
  • Value type is bytes
  • Default value is 1 Mib

The Loggly API supports event size up to 1 Mib.

You should only need to change this setting if the API limits have changed and you need to override the plugin’s behaviour.

See the Loggly bulk API documentation

max_payload_size

  • This is a required setting.
  • Value type is bytes
  • Default value is 5 Mib

The Loggly API supports API call payloads up to 5 Mib.

You should only need to change this setting if the API limits have changed and you need to override the plugin’s behaviour.

See the Loggly bulk API documentation

proto

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

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

proxy_host

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

Proxy Host

proxy_password

  • Value type is password
  • Default value is ""

Proxy Password

proxy_port

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

Proxy Port

proxy_user

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

Proxy Username

retry_count

  • 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

tag

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

Loggly Tags help you to find your logs in the Loggly dashboard easily. You can search for a tag in Loggly using "tag:logstash".

If you need to specify multiple tags here on your events, specify them as outlined in the tag documentation. E.g. "tag" => "foo,bar,myApp".

You can also use "tag" => "%{somefield}" to take your tag value from somefield on your event. Helpful for leveraging Loggly source groups.

Common Options

The following configuration options are supported by all output plugins:

Setting Input typeRequired

codec

codec

No

enable_metric

boolean

No

id

string

No

codec

  • 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_metric

  • 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.

id

  • 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 loggly outputs. Adding a named ID in this case will help in monitoring Logstash when using the monitoring APIs.

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