loggly

Milestone: 2

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.

Synopsis

This is what it might look like in your config file:

output {
  loggly {
    codec => ... # codec (optional), default: "plain"
    host => ... # string (optional), default: "logs.loggly.com"
    key => ... # string (required)
    proto => ... # string (optional), default: "http"
    proxy_host => ... # string (optional)
    proxy_password => ... # password (optional), default: ""
    proxy_port => ... # number (optional)
    proxy_user => ... # string (optional)
    workers => ... # number (optional), default: 1
  }
}

Details

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.

exclude_tags DEPRECATED

• DEPRECATED WARNING: This config item is deprecated. It may be removed in a further version.
• Value type is array
• Default value is []

Only handle events without any of these tags. Note this check is additional to type and tags.

host

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

The hostname to send logs to. This should target the loggly http input server which is usually “logs.loggly.com”

key (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.

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

tags DEPRECATED

• DEPRECATED WARNING: This config item is deprecated. It may be removed in a further version.
• Value type is array
• Default value is []

Only handle events with all of these tags. Note that if you specify a type, the event must also match that type. Optional.

type DEPRECATED

• DEPRECATED WARNING: This config item is deprecated. It may be removed in a further version.
• Value type is string
• Default value is ""

The type to act on. If a type is given, then this output will only act on messages with the same type. See any input plugin’s “type” attribute for more. Optional.

workers

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

---

This is documentation from lib/logstash/outputs/loggly.rb