Telegraf processor plugins
This page documents an earlier version of Telegraf. Telegraf v1.20 is the latest stable version.
Processor plugins process metrics as they pass through and immediately emit results based on the values they process.
Supported Telegraf processor plugins
The Converter processor plugin is used to change the type of tag or field values. In addition to changing field types, it can convert between fields and tags. Values that cannot be converted are dropped.
The Enum processor plugin allows the configuration of value mappings for metric fields. The main use case for this is to rewrite status codes such as
green by numeric values such as
2. The plugin supports string and bool types for the field values. Multiple Fields can be configured with separate value mappings for each field. Default mapping values can be configured to be used for all values, which are not contained in the value_mappings. The processor supports explicit configuration of a destination field. By default the source field is overwritten.
The Override processor plugin allows overriding all modifications that are supported by input plugins and aggregator plugins:
All metrics passing through this processor will be modified accordingly. Select the metrics to modify using the standard measurement filtering options.
name_suffix, and already present tags with conflicting keys will be overwritten. Absent tags will be created.
Use case of this plugin encompass ensuring certain tags or naming conventions are adhered to irrespective of input plugin configurations, e.g., by
The Parser processor plugin parses defined fields containing the specified data format and creates new metrics based on the contents of the field.
The Printer processor plugin simply prints every metric passing through it.
The Regex processor plugin transforms tag and field values using a regular expression (regex) pattern. If
result_key parameter is present, it can produce new tags and fields from existing ones.
The Rename processor plugin renames InfluxDB measurements, fields, and tags.
The Strings processor plugin maps certain Go string functions onto InfluxDB measurement, tag, and field values. Values can be modified in place or stored in another key.
Implemented functions are:
Note that in this implementation these are processed in the order that they appear above. You can specify the
field that you want processed in each section and optionally a
dest if you want the result stored in a new tag or field. You can specify lots of transformations on data with a single strings processor.
The TopK processor plugin is a filter designed to get the top series over a period of time. It can be tweaked to do its top
K computation over a period of time, so spikes can be smoothed out.
This processor goes through the following steps when processing a batch of metrics:
- Groups metrics in buckets using their tags and name as key.
- Aggregates each of the selected fields for each bucket by the selected aggregation function (sum, mean, etc.).
- Orders the buckets by one of the generated aggregations, returns all metrics in the top
Kbuckets, then reorders the buckets by the next of the generated aggregations, returns all metrics in the top
Kbuckets, etc, etc, etc, until it runs out of fields.
The plugin makes sure not to duplicate metrics.
Note that depending on the amount of metrics on each computed bucket, more than
K metrics may be returned.
Support and feedback
Thank you for being part of our community! We welcome and encourage your feedback and bug reports for Telegraf and this documentation. To find support, the following resources are available:
InfluxDB Cloud customers can contact InfluxData Support.