IMPORTANT: No additional bug fixes or documentation updates will be released for this version. For the latest information, see the current release documentation.

« boundary cloudwatch »

› ›

circonus

edit

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

circonus

edit

Version: 3.0.0
Released on: 2016-09-09
Changelog

This plugin does not ship with Logstash by default, but it is easy to install by running bin/logstash-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"`
`enable_metric`	boolean	No	`true`
`id`	string	No
`workers`	<<,>>	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 the 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.

`enable_metric`

edit

Value type is boolean
Default value is true

Disable or enable metric logging for this specific plugin instance by default we record all the metrics we can, but you can disable metrics collection for a specific plugin.

`id`

edit

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

Add a unique ID to the plugin instance, this ID is used for tracking information for a specific configuration of the plugin.

output {
 stdout {
   id => "ABC"
 }
}

If you don’t explicitely set this variable Logstash will generate a unique name.

`workers`

edit

Value type is string
Default value is 1

« boundary cloudwatch »