1
0
Fork 0
telegraf/plugins/processors/unpivot/README.md

57 lines
1.6 KiB
Markdown
Raw Permalink Normal View History

# Unpivot Processor Plugin
You can use the `unpivot` processor to rotate a multi field series into single
valued metrics. This transformation often results in data that is more easy to
aggregate across fields.
To perform the reverse operation use the [pivot] processor.
## Global configuration options <!-- @/docs/includes/plugin_config.md -->
In addition to the plugin-specific configuration settings, plugins support
additional global and plugin configuration settings. These settings are used to
modify metrics, tags, and field or create aliases and configure ordering, etc.
See the [CONFIGURATION.md][CONFIGURATION.md] for more details.
[CONFIGURATION.md]: ../../../docs/CONFIGURATION.md#plugins
## Configuration
```toml @sample.conf
# Rotate multi field metric into several single field metrics
[[processors.unpivot]]
## Metric mode to pivot to
## Set to "tag", metrics are pivoted as a tag and the metric is kept as
## the original measurement name. Tag key name is set by tag_key value.
## Set to "metric" creates a new metric named the field name. With this
## option the tag_key is ignored. Be aware that this could lead to metric
## name conflicts!
# use_fieldname_as = "tag"
## Tag to use for the name.
# tag_key = "name"
## Field to use for the name of the value.
# value_key = "value"
```
## Example
Metric mode `tag`:
```diff
- cpu,cpu=cpu0 time_idle=42i,time_user=43i
+ cpu,cpu=cpu0,name=time_idle value=42i
+ cpu,cpu=cpu0,name=time_user value=43i
```
Metric mode `metric`:
```diff
- cpu,cpu=cpu0 time_idle=42i,time_user=43i
+ time_idle,cpu=cpu0 value=42i
+ time_user,cpu=cpu0 value=43i
```
[pivot]: /plugins/processors/pivot/README.md