circonusedit

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

 

Synopsisedit

This plugin supports the following configuration options:

Required configuration options:

circonus {
    annotation => ...
    api_token => ...
    app_name => ...
}

Available configuration options:

Setting Input typeRequiredDefault value

annotation

hash

Yes

{}

api_token

string

Yes

app_name

string

Yes

codec

codec

No

"plain"

workers

number

No

1

Detailsedit

 

annotationedit

  • This is a 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_tokenedit

  • This is a 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_nameedit

  • This is a 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}"

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.

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.