IMPORTANT: No additional bug fixes or documentation updates will be released for this version. For the latest information, see the current release documentation.
« boundary csv »
Elastic Docs ›Logstash Reference [1.5] ›Logstash Reference ›Output plugins

circonus

edit
IMPORTANT: This documentation is no longer updated. Refer to Elastic's version policy and the latest documentation.

circonus

edit

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

 

Synopsis

edit

This plugin supports the following configuration options:

Required configuration options:

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

Available configuration options:

Setting Input type Required Default value

annotation

hash

Yes

{}

api_token

string

Yes

app_name

string

Yes

codec

codec

No

"plain"

workers

number

No

1

Details

edit

 

annotation

edit
  • 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
[source,ruby]
  ["title":"Logstash event", "description":"Logstash event for %{host}", "parent_id", "1"]

api_token

edit
  • 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_name

edit
  • 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}"

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.

exclude_tags (DEPRECATED)

edit
  • DEPRECATED WARNING: This configuration item is deprecated and may not be available in future versions.
  • Value type is array
  • Default value is []

Only handle events without any of these tags. Optional.

tags (DEPRECATED)

edit
  • DEPRECATED WARNING: This configuration item is deprecated and may not be available in future versions.
  • Value type is array
  • Default value is []

Only handle events with all of these tags. Optional.

type (DEPRECATED)

edit
  • DEPRECATED WARNING: This configuration item is deprecated and may not be available in future versions.
  • 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

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

« boundary csv »