Adding upstream version 1.34.4.
Signed-off-by: Daniel Baumann <daniel@debian.org>
This commit is contained in:
parent
e393c3af3f
commit
4978089aab
GPG key ID:
FBB4F0E80A80222F
4963 changed files with 677545 additions and 0 deletions
56
plugins/processors/unpivot/README.md
Normal file
56
plugins/processors/unpivot/README.md
Normal file
|
|
@ -0,0 +1,56 @@
|
|||
# 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
|
||||
15
plugins/processors/unpivot/sample.conf
Normal file
15
plugins/processors/unpivot/sample.conf
Normal file
|
|
@ -0,0 +1,15 @@
|
|||
# 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"
|
||||
82
plugins/processors/unpivot/unpivot.go
Normal file
82
plugins/processors/unpivot/unpivot.go
Normal file
|
|
@ -0,0 +1,82 @@
|
|||
//go:generate ../../../tools/readme_config_includer/generator
|
||||
package unpivot
|
||||
|
||||
import (
|
||||
_ "embed"
|
||||
"fmt"
|
||||
|
||||
"github.com/influxdata/telegraf"
|
||||
"github.com/influxdata/telegraf/metric"
|
||||
"github.com/influxdata/telegraf/plugins/processors"
|
||||
)
|
||||
|
||||
//go:embed sample.conf
|
||||
var sampleConfig string
|
||||
|
||||
type Unpivot struct {
|
||||
FieldNameAs string `toml:"use_fieldname_as"`
|
||||
TagKey string `toml:"tag_key"`
|
||||
ValueKey string `toml:"value_key"`
|
||||
}
|
||||
|
||||
func (*Unpivot) SampleConfig() string {
|
||||
return sampleConfig
|
||||
}
|
||||
|
||||
func (p *Unpivot) Init() error {
|
||||
switch p.FieldNameAs {
|
||||
case "", "tag":
|
||||
p.FieldNameAs = "tag"
|
||||
case "metric":
|
||||
default:
|
||||
return fmt.Errorf("unrecognized metric mode: %q", p.FieldNameAs)
|
||||
}
|
||||
|
||||
if p.TagKey == "" {
|
||||
p.TagKey = "name"
|
||||
}
|
||||
if p.ValueKey == "" {
|
||||
p.ValueKey = "value"
|
||||
}
|
||||
|
||||
return nil
|
||||
}
|
||||
|
||||
func (p *Unpivot) Apply(metrics ...telegraf.Metric) []telegraf.Metric {
|
||||
fieldCount := 0
|
||||
for _, m := range metrics {
|
||||
fieldCount += len(m.FieldList())
|
||||
}
|
||||
results := make([]telegraf.Metric, 0, fieldCount)
|
||||
|
||||
for _, src := range metrics {
|
||||
// Create a copy without fields and tracking information
|
||||
base := metric.New(src.Name(), make(map[string]string), make(map[string]interface{}), src.Time())
|
||||
for _, t := range src.TagList() {
|
||||
base.AddTag(t.Key, t.Value)
|
||||
}
|
||||
|
||||
// Create a new metric per field and add it to the output
|
||||
for _, field := range src.FieldList() {
|
||||
m := base.Copy()
|
||||
m.AddField(p.ValueKey, field.Value)
|
||||
|
||||
switch p.FieldNameAs {
|
||||
case "metric":
|
||||
m.SetName(field.Key)
|
||||
case "tag":
|
||||
m.AddTag(p.TagKey, field.Key)
|
||||
}
|
||||
|
||||
results = append(results, m)
|
||||
}
|
||||
src.Accept()
|
||||
}
|
||||
return results
|
||||
}
|
||||
|
||||
func init() {
|
||||
processors.Add("unpivot", func() telegraf.Processor {
|
||||
return &Unpivot{}
|
||||
})
|
||||
}
|
||||
334
plugins/processors/unpivot/unpivot_test.go
Normal file
334
plugins/processors/unpivot/unpivot_test.go
Normal file
|
|
@ -0,0 +1,334 @@
|
|||
package unpivot
|
||||
|
||||
import (
|
||||
"strconv"
|
||||
"sync"
|
||||
"testing"
|
||||
"time"
|
||||
|
||||
"github.com/stretchr/testify/require"
|
||||
|
||||
"github.com/influxdata/telegraf"
|
||||
"github.com/influxdata/telegraf/metric"
|
||||
"github.com/influxdata/telegraf/testutil"
|
||||
)
|
||||
|
||||
func TestDefaults(t *testing.T) {
|
||||
unpivot := &Unpivot{}
|
||||
require.NoError(t, unpivot.Init())
|
||||
require.Equal(t, "tag", unpivot.FieldNameAs)
|
||||
require.Equal(t, "name", unpivot.TagKey)
|
||||
require.Equal(t, "value", unpivot.ValueKey)
|
||||
}
|
||||
|
||||
func TestInvalidMetricMode(t *testing.T) {
|
||||
unpivot := &Unpivot{FieldNameAs: "unknown"}
|
||||
require.Error(t, unpivot.Init())
|
||||
}
|
||||
|
||||
func TestOriginalMode(t *testing.T) {
|
||||
now := time.Now()
|
||||
tests := []struct {
|
||||
name string
|
||||
tagKey string
|
||||
valueKey string
|
||||
|
||||
metrics []telegraf.Metric
|
||||
expected []telegraf.Metric
|
||||
}{
|
||||
{
|
||||
name: "simple",
|
||||
tagKey: "name",
|
||||
valueKey: "value",
|
||||
metrics: []telegraf.Metric{
|
||||
testutil.MustMetric("cpu",
|
||||
map[string]string{},
|
||||
map[string]interface{}{
|
||||
"idle_time": int64(42),
|
||||
},
|
||||
now,
|
||||
),
|
||||
},
|
||||
expected: []telegraf.Metric{
|
||||
testutil.MustMetric("cpu",
|
||||
map[string]string{
|
||||
"name": "idle_time",
|
||||
},
|
||||
map[string]interface{}{
|
||||
"value": int64(42),
|
||||
},
|
||||
now,
|
||||
),
|
||||
},
|
||||
},
|
||||
{
|
||||
name: "multi fields",
|
||||
tagKey: "name",
|
||||
valueKey: "value",
|
||||
metrics: []telegraf.Metric{
|
||||
testutil.MustMetric("cpu",
|
||||
map[string]string{},
|
||||
map[string]interface{}{
|
||||
"idle_time": int64(42),
|
||||
"idle_user": int64(43),
|
||||
},
|
||||
now,
|
||||
),
|
||||
},
|
||||
expected: []telegraf.Metric{
|
||||
testutil.MustMetric("cpu",
|
||||
map[string]string{
|
||||
"name": "idle_time",
|
||||
},
|
||||
map[string]interface{}{
|
||||
"value": int64(42),
|
||||
},
|
||||
now,
|
||||
),
|
||||
testutil.MustMetric("cpu",
|
||||
map[string]string{
|
||||
"name": "idle_user",
|
||||
},
|
||||
map[string]interface{}{
|
||||
"value": int64(43),
|
||||
},
|
||||
now,
|
||||
),
|
||||
},
|
||||
},
|
||||
}
|
||||
for _, tt := range tests {
|
||||
t.Run(tt.name, func(t *testing.T) {
|
||||
plugin := &Unpivot{
|
||||
TagKey: tt.tagKey,
|
||||
ValueKey: tt.valueKey,
|
||||
}
|
||||
require.NoError(t, plugin.Init())
|
||||
|
||||
actual := plugin.Apply(tt.metrics...)
|
||||
testutil.RequireMetricsEqual(t, tt.expected, actual, testutil.SortMetrics())
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
func TestFieldMode(t *testing.T) {
|
||||
now := time.Now()
|
||||
tests := []struct {
|
||||
name string
|
||||
fieldNameAs string
|
||||
tagKey string
|
||||
valueKey string
|
||||
metrics []telegraf.Metric
|
||||
expected []telegraf.Metric
|
||||
}{
|
||||
{
|
||||
name: "simple",
|
||||
fieldNameAs: "metric",
|
||||
tagKey: "name",
|
||||
valueKey: "value",
|
||||
metrics: []telegraf.Metric{
|
||||
testutil.MustMetric("cpu",
|
||||
map[string]string{},
|
||||
map[string]interface{}{
|
||||
"idle_time": int64(42),
|
||||
},
|
||||
now,
|
||||
),
|
||||
},
|
||||
expected: []telegraf.Metric{
|
||||
testutil.MustMetric("idle_time",
|
||||
map[string]string{},
|
||||
map[string]interface{}{
|
||||
"value": int64(42),
|
||||
},
|
||||
now,
|
||||
),
|
||||
},
|
||||
},
|
||||
{
|
||||
name: "multi fields",
|
||||
fieldNameAs: "metric",
|
||||
tagKey: "name",
|
||||
valueKey: "value",
|
||||
metrics: []telegraf.Metric{
|
||||
testutil.MustMetric("cpu",
|
||||
map[string]string{},
|
||||
map[string]interface{}{
|
||||
"idle_time": int64(42),
|
||||
"idle_user": int64(43),
|
||||
},
|
||||
now,
|
||||
),
|
||||
},
|
||||
expected: []telegraf.Metric{
|
||||
testutil.MustMetric("idle_time",
|
||||
map[string]string{},
|
||||
map[string]interface{}{
|
||||
"value": int64(42),
|
||||
},
|
||||
now,
|
||||
),
|
||||
testutil.MustMetric("idle_user",
|
||||
map[string]string{},
|
||||
map[string]interface{}{
|
||||
"value": int64(43),
|
||||
},
|
||||
now,
|
||||
),
|
||||
},
|
||||
},
|
||||
{
|
||||
name: "multi fields and tags",
|
||||
fieldNameAs: "metric",
|
||||
tagKey: "name",
|
||||
valueKey: "value",
|
||||
metrics: []telegraf.Metric{
|
||||
testutil.MustMetric("cpu",
|
||||
map[string]string{
|
||||
"building": "5a",
|
||||
},
|
||||
map[string]interface{}{
|
||||
"idle_time": int64(42),
|
||||
"idle_user": int64(43),
|
||||
},
|
||||
now,
|
||||
),
|
||||
},
|
||||
expected: []telegraf.Metric{
|
||||
testutil.MustMetric("idle_time",
|
||||
map[string]string{
|
||||
"building": "5a",
|
||||
},
|
||||
map[string]interface{}{
|
||||
"value": int64(42),
|
||||
},
|
||||
now,
|
||||
),
|
||||
testutil.MustMetric("idle_user",
|
||||
map[string]string{
|
||||
"building": "5a",
|
||||
},
|
||||
map[string]interface{}{
|
||||
"value": int64(43),
|
||||
},
|
||||
now,
|
||||
),
|
||||
},
|
||||
},
|
||||
}
|
||||
for _, tt := range tests {
|
||||
t.Run(tt.name, func(t *testing.T) {
|
||||
plugin := &Unpivot{
|
||||
FieldNameAs: tt.fieldNameAs,
|
||||
TagKey: tt.tagKey,
|
||||
ValueKey: tt.valueKey,
|
||||
}
|
||||
require.NoError(t, plugin.Init())
|
||||
|
||||
actual := plugin.Apply(tt.metrics...)
|
||||
testutil.RequireMetricsEqual(t, tt.expected, actual, testutil.SortMetrics())
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
func TestTrackedMetricNotLost(t *testing.T) {
|
||||
var mu sync.Mutex
|
||||
delivered := make([]telegraf.DeliveryInfo, 0, 3)
|
||||
notify := func(di telegraf.DeliveryInfo) {
|
||||
mu.Lock()
|
||||
defer mu.Unlock()
|
||||
delivered = append(delivered, di)
|
||||
}
|
||||
input := make([]telegraf.Metric, 0, 3)
|
||||
expected := make([]telegraf.Metric, 0, 6)
|
||||
for i := 0; i < 3; i++ {
|
||||
strI := strconv.Itoa(i)
|
||||
|
||||
m := metric.New("m"+strI, map[string]string{}, map[string]interface{}{"x": int64(1), "y": int64(2)}, time.Unix(0, 0))
|
||||
tm, _ := metric.WithTracking(m, notify)
|
||||
input = append(input, tm)
|
||||
|
||||
unpivot1 := metric.New("m"+strI, map[string]string{"name": "x"}, map[string]interface{}{"value": int64(1)}, time.Unix(0, 0))
|
||||
unpivot2 := metric.New("m"+strI, map[string]string{"name": "y"}, map[string]interface{}{"value": int64(2)}, time.Unix(0, 0))
|
||||
expected = append(expected, unpivot1, unpivot2)
|
||||
}
|
||||
|
||||
// Process expected metrics and compare with resulting metrics
|
||||
plugin := &Unpivot{TagKey: "name", ValueKey: "value"}
|
||||
require.NoError(t, plugin.Init())
|
||||
|
||||
actual := plugin.Apply(input...)
|
||||
testutil.RequireMetricsEqual(t, expected, actual, testutil.SortMetrics())
|
||||
|
||||
// Simulate output acknowledging delivery
|
||||
for _, m := range actual {
|
||||
m.Accept()
|
||||
}
|
||||
|
||||
// Check delivery
|
||||
require.Eventuallyf(t, func() bool {
|
||||
mu.Lock()
|
||||
defer mu.Unlock()
|
||||
return len(input) == len(delivered)
|
||||
}, time.Second, 100*time.Millisecond, "%d delivered but %d expected", len(delivered), len(input))
|
||||
}
|
||||
|
||||
func BenchmarkAsTag(b *testing.B) {
|
||||
input := metric.New(
|
||||
"test",
|
||||
map[string]string{
|
||||
"source": "device A",
|
||||
"location": "main building",
|
||||
},
|
||||
map[string]interface{}{
|
||||
"field0": 0.1,
|
||||
"field1": 1.2,
|
||||
"field2": 2.3,
|
||||
"field3": 3.4,
|
||||
"field4": 4.5,
|
||||
"field5": 5.6,
|
||||
"field6": 6.7,
|
||||
"field7": 7.8,
|
||||
"field8": 8.9,
|
||||
"field9": 9.0,
|
||||
},
|
||||
time.Now(),
|
||||
)
|
||||
|
||||
plugin := &Unpivot{}
|
||||
require.NoError(b, plugin.Init())
|
||||
|
||||
for n := 0; n < b.N; n++ {
|
||||
plugin.Apply(input)
|
||||
}
|
||||
}
|
||||
|
||||
func BenchmarkAsMetric(b *testing.B) {
|
||||
input := metric.New(
|
||||
"test",
|
||||
map[string]string{
|
||||
"source": "device A",
|
||||
"location": "main building",
|
||||
},
|
||||
map[string]interface{}{
|
||||
"field0": 0.1,
|
||||
"field1": 1.2,
|
||||
"field2": 2.3,
|
||||
"field3": 3.4,
|
||||
"field4": 4.5,
|
||||
"field5": 5.6,
|
||||
"field6": 6.7,
|
||||
"field7": 7.8,
|
||||
"field8": 8.9,
|
||||
"field9": 9.0,
|
||||
},
|
||||
time.Now(),
|
||||
)
|
||||
|
||||
plugin := &Unpivot{FieldNameAs: "metric"}
|
||||
require.NoError(b, plugin.Init())
|
||||
|
||||
for n := 0; n < b.N; n++ {
|
||||
plugin.Apply(input)
|
||||
}
|
||||
}
|
||||
Loading…
Add table
Add a link
Reference in a new issue