circonus

Milestone: 1

This is a community-contributed plugin! It does not ship with logstash by default, but it is easy to install! To use this, you must have installed the contrib plugins package.

Synopsis

This is what it might look like in your config file:
output {
  circonus {
    annotation => ... # hash (required), default: {}
    api_token => ... # string (required)
    app_name => ... # string (required)
    codec => ... # codec (optional), default: "plain"
    workers => ... # number (optional), default: 1
  }
}

Details

annotation (required setting)

  • Value type is hash
  • Default value is {}

Annotations Registers an annotation with Circonus The only required field is title and description. start and stop will be set to event["@timestamp"] You can add any other optional annotation values as well. All values will be passed through event.sprintf

Example: [“title”:”Logstash event”, “description”:”Logstash event for %{host}”] or [“title”:”Logstash event”, “description”:”Logstash event for %{host}”, “parent_id”, “1”]

api_token (required setting)

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

This output lets you send annotations to Circonus based on Logstash events

Your Circonus API Token

app_name (required setting)

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

Your Circonus App name This will be passed through event.sprintf so variables are allowed here:

Example: app_name => "%{myappname}"

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.

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/circonus.rb