chore: Embed sample configurations into README for processors (#11189)

Makefile

@@ -126,11 +126,11 @@ generate_plugins_%: build_generator
 	go generate -run="plugindata/main.go$$" ./plugins/$*/...
 
 .PHONY: generate
-generate: insert_config_to_readme_inputs insert_config_to_readme_outputs generate_plugins_processors generate_plugins_aggregators
+generate: insert_config_to_readme_inputs insert_config_to_readme_outputs insert_config_to_readme_processors generate_plugins_aggregators
 
 .PHONY: generate-clean
 generate-clean:
-	go generate -run="plugindata/main.go --clean" ./plugins/processors/... ./plugins/aggregators/...
+	go generate -run="plugindata/main.go --clean" ./plugins/aggregators/...
 
 .PHONY: build
 build:

plugins/processors/aws/ec2/README.md

@@ -7,7 +7,7 @@ to metrics associated with EC2 instances.
 
 ## Configuration
 
-```toml
+```toml @sample.conf
 # Attach AWS EC2 metadata to metrics
 [[processors.aws_ec2]]
   ## Instance identity document tags to attach to metrics.

plugins/processors/aws/ec2/ec2.go

@@ -1,7 +1,9 @@
+//go:generate ../../../../tools/readme_config_includer/generator
 package ec2
 
 import (
 	"context"
+	_ "embed"
 	"errors"
 	"fmt"
 	"strings"
@@ -20,6 +22,10 @@ import (
 	"github.com/influxdata/telegraf/plugins/processors"
 )
 
+// DO NOT REMOVE THE NEXT TWO LINES! This is required to embedd the sampleConfig data.
+//go:embed sample.conf
+var sampleConfig string
+
 type AwsEc2Processor struct {
 	ImdsTags         []string        `toml:"imds_tags"`
 	EC2Tags          []string        `toml:"ec2_tags"`
@@ -57,6 +63,10 @@ var allowedImdsTags = map[string]struct{}{
 	"version":          {},
 }
 
+func (*AwsEc2Processor) SampleConfig() string {
+	return sampleConfig
+}
+
 func (r *AwsEc2Processor) Add(metric telegraf.Metric, _ telegraf.Accumulator) error {
 	r.parallel.Enqueue(metric)
 	return nil

plugins/processors/clone/README.md

@@ -24,7 +24,7 @@ having several hosts (modifying ``host`` tag).
 
 ## Configuration
 
-```toml
+```toml @sample.conf
 # Apply metric modifications using override semantics.
 [[processors.clone]]
   ## All modifications on inputs and aggregators can be overridden:

plugins/processors/clone/clone.go

@@ -1,17 +1,28 @@
+//go:generate ../../../tools/readme_config_includer/generator
 package clone
 
 import (
+	_ "embed"
+
 	"github.com/influxdata/telegraf"
 	"github.com/influxdata/telegraf/plugins/processors"
 )
 
+// DO NOT REMOVE THE NEXT TWO LINES! This is required to embedd the sampleConfig data.
+//go:embed sample.conf
+var sampleConfig string
+
 type Clone struct {
 	NameOverride string
 	NamePrefix   string
 	NameSuffix   string
 	Tags         map[string]string
 }
 
+func (*Clone) SampleConfig() string {
+	return sampleConfig
+}
+
 func (c *Clone) Apply(in ...telegraf.Metric) []telegraf.Metric {
 	cloned := []telegraf.Metric{}
 

plugins/processors/converter/README.md

@@ -13,7 +13,7 @@ will overwrite one another.
 
 ## Configuration
 
-```toml
+```toml @sample.conf
 # Convert values to another metric value type
 [[processors.converter]]
   ## Tags to convert

plugins/processors/converter/converter.go

@@ -1,6 +1,8 @@
+//go:generate ../../../tools/readme_config_includer/generator
 package converter
 
 import (
+	_ "embed"
 	"errors"
 	"fmt"
 	"math"
@@ -13,6 +15,10 @@ import (
 	"github.com/influxdata/telegraf/plugins/processors"
 )
 
+// DO NOT REMOVE THE NEXT TWO LINES! This is required to embedd the sampleConfig data.
+//go:embed sample.conf
+var sampleConfig string
+
 type Conversion struct {
 	Measurement []string `toml:"measurement"`
 	Tag         []string `toml:"tag"`
@@ -42,6 +48,10 @@ type ConversionFilter struct {
 	Float       filter.Filter
 }
 
+func (*Converter) SampleConfig() string {
+	return sampleConfig
+}
+
 func (p *Converter) Init() error {
 	return p.compile()
 }

plugins/processors/date/README.md

@@ -12,7 +12,7 @@ A few example usecases include:
 
 ## Configuration
 
-```toml
+```toml @sample.conf
 # Dates measurements, tags, and fields that pass through this filter.
 [[processors.date]]
   ## New tag to create

plugins/processors/date/date.go

@@ -1,6 +1,8 @@
+//go:generate ../../../tools/readme_config_includer/generator
 package date
 
 import (
+	_ "embed"
 	"errors"
 	"time"
 
@@ -9,6 +11,10 @@ import (
 	"github.com/influxdata/telegraf/plugins/processors"
 )
 
+// DO NOT REMOVE THE NEXT TWO LINES! This is required to embedd the sampleConfig data.
+//go:embed sample.conf
+var sampleConfig string
+
 const defaultTimezone = "UTC"
 
 type Date struct {
@@ -21,6 +27,10 @@ type Date struct {
 	location *time.Location
 }
 
+func (*Date) SampleConfig() string {
+	return sampleConfig
+}
+
 func (d *Date) Init() error {
 	// Check either TagKey or FieldKey specified
 	if len(d.FieldKey) > 0 && len(d.TagKey) > 0 {

plugins/processors/dedup/README.md

@@ -4,7 +4,7 @@ Filter metrics whose field values are exact repetitions of the previous values.
 
 ## Configuration
 
-```toml
+```toml @sample.conf
 # Filter metrics with repeating field values
 [[processors.dedup]]
   ## Maximum time to suppress output

plugins/processors/dedup/dedup.go

@@ -1,13 +1,19 @@
+//go:generate ../../../tools/readme_config_includer/generator
 package dedup
 
 import (
+	_ "embed"
 	"time"
 
 	"github.com/influxdata/telegraf"
 	"github.com/influxdata/telegraf/config"
 	"github.com/influxdata/telegraf/plugins/processors"
 )
 
+// DO NOT REMOVE THE NEXT TWO LINES! This is required to embedd the sampleConfig data.
+//go:embed sample.conf
+var sampleConfig string
+
 type Dedup struct {
 	DedupInterval config.Duration `toml:"dedup_interval"`
 	FlushTime     time.Time
@@ -36,6 +42,10 @@ func (d *Dedup) save(metric telegraf.Metric, id uint64) {
 	d.Cache[id].Accept()
 }
 
+func (*Dedup) SampleConfig() string {
+	return sampleConfig
+}
+
 // main processing method
 func (d *Dedup) Apply(metrics ...telegraf.Metric) []telegraf.Metric {
 	idx := 0

plugins/processors/defaults/README.md

@@ -12,7 +12,7 @@ Telegraf minimum version: Telegraf 1.15.0
 
 ## Configuration
 
-```toml
+```toml @sample.conf
 ## Set default fields on your metric(s) when they are nil or empty
 [[processors.defaults]]
   ## Ensures a set of fields always exists on your metric(s) with their

plugins/processors/defaults/defaults.go

@@ -1,18 +1,28 @@
+//go:generate ../../../tools/readme_config_includer/generator
 package defaults
 
 import (
+	_ "embed"
 	"strings"
 
 	"github.com/influxdata/telegraf"
 	"github.com/influxdata/telegraf/plugins/processors"
 )
 
+// DO NOT REMOVE THE NEXT TWO LINES! This is required to embedd the sampleConfig data.
+//go:embed sample.conf
+var sampleConfig string
+
 // Defaults is a processor for ensuring certain fields always exist
 // on your Metrics with at least a default value.
 type Defaults struct {
 	DefaultFieldsSets map[string]interface{} `toml:"fields"`
 }
 
+func (*Defaults) SampleConfig() string {
+	return sampleConfig
+}
+
 // Apply contains the main implementation of this processor.
 // For each metric in 'inputMetrics', it goes over each default pair.
 // If the field in the pair does not exist on the metric, the associated default is added.

plugins/processors/enum/README.md

@@ -11,7 +11,7 @@ source tag or field is overwritten.
 
 ## Configuration
 
-```toml
+```toml @sample.conf
 # Map enum values according to given table.
 [[processors.enum]]
   [[processors.enum.mapping]]

plugins/processors/enum/enum.go

@@ -1,6 +1,8 @@
+//go:generate ../../../tools/readme_config_includer/generator
 package enum
 
 import (
+	_ "embed"
 	"fmt"
 	"strconv"
 
@@ -9,6 +11,10 @@ import (
 	"github.com/influxdata/telegraf/plugins/processors"
 )
 
+// DO NOT REMOVE THE NEXT TWO LINES! This is required to embedd the sampleConfig data.
+//go:embed sample.conf
+var sampleConfig string
+
 type EnumMapper struct {
 	Mappings []Mapping `toml:"mapping"`
 
@@ -24,6 +30,10 @@ type Mapping struct {
 	ValueMappings map[string]interface{}
 }
 
+func (*EnumMapper) SampleConfig() string {
+	return sampleConfig
+}
+
 func (mapper *EnumMapper) Init() error {
 	mapper.FieldFilters = make(map[string]filter.Filter)
 	mapper.TagFilters = make(map[string]filter.Filter)

plugins/processors/execd/README.md

@@ -22,7 +22,7 @@ Telegraf minimum version: Telegraf 1.15.0
 
 ## Configuration
 
-```toml
+```toml @sample.conf
 # Run executable as long-running processor plugin
 [[processors.execd]]
   ## One program to run as daemon.

plugins/processors/execd/execd.go

@@ -1,7 +1,9 @@
+//go:generate ../../../tools/readme_config_includer/generator
 package execd
 
 import (
 	"bufio"
+	_ "embed"
 	"errors"
 	"fmt"
 	"io"
@@ -17,6 +19,10 @@ import (
 	"github.com/influxdata/telegraf/plugins/serializers"
 )
 
+// DO NOT REMOVE THE NEXT TWO LINES! This is required to embedd the sampleConfig data.
+//go:embed sample.conf
+var sampleConfig string
+
 type Execd struct {
 	Command      []string        `toml:"command"`
 	Environment  []string        `toml:"environment"`
@@ -43,6 +49,10 @@ func New() *Execd {
 	}
 }
 
+func (*Execd) SampleConfig() string {
+	return sampleConfig
+}
+
 func (e *Execd) Start(acc telegraf.Accumulator) error {
 	var err error
 	e.parser, err = parsers.NewParser(e.parserConfig)