51 lines
1.6 KiB
Markdown
51 lines
1.6 KiB
Markdown
# Enum Processor Plugin
|
|
|
|
The Enum Processor allows the configuration of value mappings for metric tags or fields.
|
|
The main use-case for this is to rewrite status codes such as _red_, _amber_ and
|
|
_green_ by numeric values such as 0, 1, 2. The plugin supports string and bool
|
|
types for the field values. Multiple tags or fields can be configured with separate
|
|
value mappings for each. 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 tag or field. By default the
|
|
source tag or field is overwritten.
|
|
|
|
### Configuration:
|
|
|
|
```toml
|
|
[[processors.enum]]
|
|
[[processors.enum.mapping]]
|
|
## Name of the field to map
|
|
field = "status"
|
|
|
|
## Name of the tag to map
|
|
# tag = "status"
|
|
|
|
## Destination tag or field to be used for the mapped value. By default the
|
|
## source tag or field is used, overwriting the original value.
|
|
dest = "status_code"
|
|
|
|
## Default value to be used for all values not contained in the mapping
|
|
## table. When unset and no match is found, the original field will remain
|
|
## unmodified and the destination tag or field will not be created.
|
|
# default = 0
|
|
|
|
## Table of mappings
|
|
[processors.enum.mapping.value_mappings]
|
|
green = 1
|
|
amber = 2
|
|
red = 3
|
|
```
|
|
|
|
### Example:
|
|
|
|
```diff
|
|
- xyzzy status="green" 1502489900000000000
|
|
+ xyzzy status="green",status_code=1i 1502489900000000000
|
|
```
|
|
|
|
With unknown value and no default set:
|
|
```diff
|
|
- xyzzy status="black" 1502489900000000000
|
|
+ xyzzy status="black" 1502489900000000000
|
|
```
|