3.4 KiB
| navigation_title | mapped_pages | |
|---|---|---|
| graphite |
|
Graphite codec plugin [plugins-codecs-graphite]
- Plugin version: v3.0.6
- Released on: 2021-08-12
- Changelog
For other versions, see the Versioned plugin docs.
Getting help [_getting_help_183]
For 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 [_description_182]
This codec will encode and decode Graphite formated lines.
Graphite Codec Configuration Options [plugins-codecs-graphite-options]
| Setting | Input type | Required |
|---|---|---|
exclude_metrics |
array | No |
fields_are_metrics |
boolean | No |
include_metrics |
array | No |
metrics |
hash | No |
metrics_format |
string | No |
exclude_metrics [plugins-codecs-graphite-exclude_metrics]
- Value type is array
- Default value is
["%{[^}]+}"]
Exclude regex matched metric names, by default exclude unresolved %{{field}} strings
fields_are_metrics [plugins-codecs-graphite-fields_are_metrics]
- 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 [plugins-codecs-graphite-include_metrics]
- Value type is array
- Default value is
[".*"]
Include only regex matched metric names
metrics [plugins-codecs-graphite-metrics]
- 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 [plugins-codecs-graphite-metrics_format]
- 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"
::::{note} If no metrics_format is defined the name of the metric will be used as fallback. ::::