Add comment about MultiLineBuilder

amazon-contributing · Sep 28, 2023 · d5e2a19 · d5e2a19
1 parent 1731651
commit d5e2a19
Showing 1 changed file with 11 additions and 9 deletions.
diff --git a/pkg/stanza/operator/input/tcp/tcp.go b/pkg/stanza/operator/input/tcp/tcp.go
@@ -69,15 +69,17 @@ type Config struct {
 
 // BaseConfig is the detailed configuration of a tcp input operator.
 type BaseConfig struct {
-	MaxLogSize       helper.ByteSize             `mapstructure:"max_log_size,omitempty"`
-	ListenAddress    string                      `mapstructure:"listen_address,omitempty"`
-	TLS              *configtls.TLSServerSetting `mapstructure:"tls,omitempty"`
-	AddAttributes    bool                        `mapstructure:"add_attributes,omitempty"`
-	OneLogPerPacket  bool                        `mapstructure:"one_log_per_packet,omitempty"`
-	Encoding         string                      `mapstructure:"encoding,omitempty"`
-	Multiline        tokenize.MultilineConfig    `mapstructure:"multiline,omitempty"`
-	TrimConfig       trim.Config                 `mapstructure:",squash"`
-	MultiLineBuilder MultiLineBuilderFunc        `mapstructure:"multilinebuilder,omitempty"`
+	MaxLogSize      helper.ByteSize             `mapstructure:"max_log_size,omitempty"`
+	ListenAddress   string                      `mapstructure:"listen_address,omitempty"`
+	TLS             *configtls.TLSServerSetting `mapstructure:"tls,omitempty"`
+	AddAttributes   bool                        `mapstructure:"add_attributes,omitempty"`
+	OneLogPerPacket bool                        `mapstructure:"one_log_per_packet,omitempty"`
+	Encoding        string                      `mapstructure:"encoding,omitempty"`
+	Multiline       tokenize.MultilineConfig    `mapstructure:"multiline,omitempty"`
+	TrimConfig      trim.Config                 `mapstructure:",squash"`
+	// omitempty for temporary fix since MultilineBuilder breaks yaml encoding due to being func type.
+	// multilinebuilder should never be used, but Opentelemetry unit test requires a name for any config.
+	MultiLineBuilder MultiLineBuilderFunc `mapstructure:"multilinebuilder,omitempty"`
 }
 
 type MultiLineBuilderFunc func(enc encoding.Encoding) (bufio.SplitFunc, error)