Graphite codec plugin
editGraphite codec plugin
edit- Plugin version: v3.0.5
- Released on: 2017-11-07
- 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-codec-graphite. 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 codec will encode and decode Graphite formated lines.
Graphite Codec Configuration Options
edit| Setting | Input type | Required |
|---|---|---|
No |
||
No |
||
No |
||
No |
||
No |
exclude_metrics
edit- Value type is array
-
Default value is
["%{[^}]+}"]
Exclude regex matched metric names, by default exclude unresolved %{field} strings
fields_are_metrics
edit- Value type is boolean
-
Default value is
false
Indicate that the event @fields should be treated as metrics and will be sent as is to graphite
include_metrics
edit- Value type is array
-
Default value is
[".*"]
Include only regex matched metric names
metrics
edit- Value type is hash
-
Default value is
{}
The metric(s) to use. This supports dynamic strings like %{host}
for metric names and also for values. This is a hash field with key
of the metric name, value of the metric value. Example:
[ "%{host}/uptime", "%{uptime_1m}" ]
The value will be coerced to a floating point value. Values which cannot be coerced will zero (0)
metrics_format
edit- Value type is string
-
Default value is
"*"
Defines format of the metric string. The placeholder * will be
replaced with the name of the actual metric. This supports dynamic
strings like %{host}.
metrics_format => "%{host}.foo.bar.*.sum"
If no metrics_format is defined the name of the metric will be used as fallback.