logglyedit

Note

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

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.

 

Synopsisedit

This plugin supports the following configuration options:

Required configuration options:

loggly {
    key => ...
}

Available configuration options:

Setting Input typeRequiredDefault value

codec

codec

No

"plain"

host

string

No

"logs-01.loggly.com"

key

string

Yes

proto

string

No

"http"

proxy_host

string

No

proxy_password

password

No

""

proxy_port

number

No

proxy_user

string

No

tag

string

No

"logstash"

workers

number

No

1

Detailsedit

 

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.

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

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/

workersedit

  • Value type is number
  • Default value is 1

The number of workers to use for this output. Note that this setting may not be useful for all outputs.