dom/telegraf
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Update docs for addition of override processor

Browse Source
This commit is contained in:
Daniel Nelson
2018-03-07 13:47:54 -08:00
parent 9d8b1b1e87
commit 2b65915b96
4 changed files with 31 additions and 22 deletions
Download Patch File Download Diff File Expand all files Collapse all files

27
plugins/processors/override/README.md
View File

@@ -8,9 +8,14 @@ supported by input plugins and aggregators:
* name_suffix
* tags
All metrics passing through this processor will be modified accordingly. Values
of *name_override*, *name_prefix*, *name_suffix* and already present *tags* with
conflicting keys will be overwritten. Absent *tags* will be created.
All metrics passing through this processor will be modified accordingly.
Select the metrics to modify using the standard
[measurement filtering](https://github.com/influxdata/telegraf/blob/master/docs/CONFIGURATION.md#measurement-filtering)
options.
Values of *name_override*, *name_prefix*, *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
@@ -19,12 +24,14 @@ are adhered to irrespective of input plugin configurations, e.g. by
### Configuration:
```toml
# Add a global tag to all metrics
# Apply metric modifications using override semantics.
[[processors.override]]
name_override = "new name_override"
name_prefix = "new name_prefix"
name_suffix = ":new name_suffix"
[processors.tags.add]
additional_tag = "tag_value"
existing_tag = "new tag_value"
## All modifications on inputs and aggregators can be overridden:
# name_override = "new_name"
# name_prefix = "new_name_prefix"
# name_suffix = "new_name_suffix"
## Tags to be added (all values must be strings)
# [processors.override.tags]
# additional_tag = "tag_value"
```

20
plugins/processors/override/override.go
View File

@@ -6,18 +6,14 @@ import (
)
var sampleConfig = `
## NOTE This processor will override names, name prefixes, name suffixes and
## values of tags, that are already present in the metric passed through this
## filter.
## All modifications on inputs and aggregators can be overridden:
# name_override = "new_name"
# name_prefix = "new_name_prefix"
# name_suffix = "new_name_suffix"
## All modifications on inputs and aggregators can be overridden:
# name_override = "new name"
# name_prefix = "new name_prefix"
# name_suffix = "new name_suffix"
## Tags to be added (all values must be strings)
# [processors.overide.tags]
# additional_tag = "tag_value"
## Tags to be added (all values must be strings)
# [processors.override.tags]
# additional_tag = "tag_value"
`
type Override struct {
@@ -32,7 +28,7 @@ func (p *Override) SampleConfig() string {
}
func (p *Override) Description() string {
return "Add all configured tags to all metrics that pass through this filter."
return "Apply metric modifications using override semantics."
}
func (p *Override) Apply(in ...telegraf.Metric) []telegraf.Metric {