Circonus output plugin
editCirconus output plugin
edit- Plugin version: v3.0.5
- Released on: 2018-04-06
- Changelog
For other versions, see the Versioned plugin docs.
Installation
editFor plugins not bundled by default, it is easy to install by running bin/logstash-plugin install logstash-output-circonus
. See Working with plugins for more details.
Getting Help
editFor questions about the plugin, open a topic in the Discuss forums. For bugs or feature requests, open an issue in Github. For the list of Elastic supported plugins, please consult the Elastic Support Matrix.
Description
editThis output sends annotations to Circonus based on Logstash events.
Circonus Output Configuration Options
editThis plugin supports the following configuration options plus the Common Options described later.
Also see Common Options for a list of options supported by all output plugins.
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
["title":"Logstash event", "description":"Logstash event for %{host}", "parent_id", "1"]
Common Options
editThe following configuration options are supported by all output plugins:
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 configuration. If no ID is specified, Logstash will generate one.
It is strongly recommended to set this ID in your configuration. This is particularly useful
when you have two or more plugins of the same type. For example, if you have 2 circonus outputs.
Adding a named ID in this case will help in monitoring Logstash when using the monitoring APIs.
output { circonus { id => "my_plugin_id" } }