Adjust enum readme and sample config style
This commit is contained in:
parent
500e136844
commit
bf076dab73
|
@ -9,26 +9,25 @@ 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.
|
||||
|
||||
### Configuration
|
||||
Configuration using table syntax:
|
||||
`toml
|
||||
# Configure a status mapping for field 'status'
|
||||
[[processors.enum.fields]]
|
||||
source = "status"
|
||||
destination = "code"
|
||||
default = -1
|
||||
[processors.enum.fields.value_mappings]
|
||||
green = 0
|
||||
yellow = 1
|
||||
red = 2
|
||||
`
|
||||
### Configuration:
|
||||
|
||||
Configuration using inline syntax:
|
||||
`toml
|
||||
# Configure a status mapping for field 'status'
|
||||
```toml
|
||||
[[processors.enum]]
|
||||
[[processors.enum.fields]]
|
||||
source = "status"
|
||||
destination = "code"
|
||||
default = -1
|
||||
value_mappings = {green = 0, yellow = 1, red = 2 }
|
||||
`
|
||||
## Name of the field to map
|
||||
source = "name"
|
||||
|
||||
## Destination field to be used for the mapped value. By default the source
|
||||
## field is used, overwriting the original value.
|
||||
# destination = "mapped"
|
||||
|
||||
## Default value to be used for all values not contained in the mapping
|
||||
## table. When unset, the unmodified value for the field will be used if no
|
||||
## match is found.
|
||||
# default = 0
|
||||
|
||||
## Table of mappings
|
||||
[processors.enum.fields.value_mappings]
|
||||
value1 = 1
|
||||
value2 = 2
|
||||
```
|
||||
|
|
|
@ -8,30 +8,23 @@ import (
|
|||
)
|
||||
|
||||
var sampleConfig = `
|
||||
## NOTE This processor will map metric values to different values. It is aimed
|
||||
## to map enum values to numeric values.
|
||||
[[processors.enum.fields]]
|
||||
## Name of the field to map
|
||||
source = "name"
|
||||
|
||||
## Fields to be considered
|
||||
# [[processors.enum.fields]]
|
||||
#
|
||||
# Name of the field source field to map
|
||||
# source = "name"
|
||||
#
|
||||
# Optional destination field to be used for the mapped value. Source field is
|
||||
# used, when no explicit destination is configured.
|
||||
## Destination field to be used for the mapped value. By default the source
|
||||
## field is used, overwriting the original value.
|
||||
# destination = "mapped"
|
||||
#
|
||||
# Optional default value to be used for all values not contained in the mapping
|
||||
# table. Only applied when configured.
|
||||
|
||||
## Default value to be used for all values not contained in the mapping
|
||||
## table. When unset, the unmodified value for the field will be used if no
|
||||
## match is found.
|
||||
# default = 0
|
||||
#
|
||||
# Value Mapping Table
|
||||
# [processors.enum.value_mappings]
|
||||
# value1 = 1
|
||||
# value2 = 2
|
||||
#
|
||||
## Alternatively the mapping table can be given in inline notation
|
||||
# value_mappings = {value1 = 1, value2 = 2}
|
||||
|
||||
## Table of mappings
|
||||
[processors.enum.fields.value_mappings]
|
||||
value1 = 1
|
||||
value2 = 2
|
||||
`
|
||||
|
||||
type EnumMapper struct {
|
||||
|
|
Loading…
Reference in New Issue