IMPORTANT: No additional bug fixes or documentation updates will be released for this version. For the latest information, see the current release documentation.

« librato lumberjack »

› ›

loggly

edit

loggly

edit

Version: 3.0.0
Released on: 2016-09-09
Changelog

This plugin does not ship with Logstash by default, but it is easy to install by running bin/logstash-plugin install logstash-output-loggly.

Ships logs to Loggly.

Synopsis

edit

This plugin supports the following configuration options:

Required configuration options:

loggly {
    key => ...
}

Available configuration options:

Setting	Input type	Required	Default value
`can_retry`	boolean	No	`true`
`codec`	codec	No	`"plain"`
`enable_metric`	boolean	No	`true`
`host`	string	No	`"logs-01.loggly.com"`
`id`	string	No
`key`	string	Yes
`proto`	string	No	`"http"`
`proxy_host`	string	No
`proxy_password`	password	No	`""`
`proxy_port`	number	No
`proxy_user`	string	No
`retry_count`	number	No	`5`
`tag`	string	No	`"logstash"`
`workers`	<<,>>	No	`1`

Details

edit

`can_retry`

edit

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

`codec`

edit

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`

edit

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.

`host`

edit

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/

`id`

edit

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

Add a unique ID to the plugin instance, this ID is used for tracking information for a specific configuration of the plugin.

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

If you don’t explicitely set this variable Logstash will generate a unique name.

`key`

edit

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.

`proto`

edit

Value type is string
Default value is "http"

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

`proxy_host`

edit

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

Proxy Host

`proxy_password`

edit

Value type is password
Default value is ""

Proxy Password

`proxy_port`

edit

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

Proxy Port

`proxy_user`

edit

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

Proxy Username

`retry_count`

edit

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`

edit

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.

You can use %{somefield} to allow for custom tag values. Helpful for leveraging Loggly source groups. https://www.loggly.com/docs/source-groups/

`workers`

edit

Value type is string
Default value is 1

« librato lumberjack »