circonus
editcirconus
editThis 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
editThis plugin supports the following configuration options:
Required configuration options:
circonus { annotation => ... api_token => ... app_name => ... }
Available configuration options:
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.