tcplog

Documentation

Overview

Package tcplog provides an otelcol.receiver.tcplog component.

Index

• type Arguments
  • func (args Arguments) Convert() (otelcomponent.Config, error)
  • func (args Arguments) DebugMetricsConfig() otelcolCfg.DebugMetricsArguments
  • func (args Arguments) Exporters() map[pipeline.Signal]map[otelcomponent.ID]otelcomponent.Component
  • func (args Arguments) Extensions() map[otelcomponent.ID]otelcomponent.Component
  • func (args Arguments) NextConsumers() *otelcol.ConsumerArguments
  • func (args *Arguments) SetToDefault()
  • func (args *Arguments) Validate() error
• type MultilineConfig
  • func (c *MultilineConfig) Convert() *split.Config

Types

type Arguments

type Arguments struct {
	ListenAddress   string                      `alloy:"listen_address,attr"`
	MaxLogSize      units.Base2Bytes            `alloy:"max_log_size,attr,optional"`
	TLS             *otelcol.TLSServerArguments `alloy:"tls,block,optional"`
	AddAttributes   bool                        `alloy:"add_attributes,attr,optional"`
	OneLogPerPacket bool                        `alloy:"one_log_per_packet,attr,optional"`
	Encoding        string                      `alloy:"encoding,attr,optional"`
	MultilineConfig *MultilineConfig            `alloy:"multiline,block,optional"`

	ConsumerRetry otelcol.ConsumerRetryArguments `alloy:"retry_on_failure,block,optional"`

	// DebugMetrics configures component internal metrics. Optional.
	DebugMetrics otelcolCfg.DebugMetricsArguments `alloy:"debug_metrics,block,optional"`

	// Output configures where to send received data. Required.
	Output *otelcol.ConsumerArguments `alloy:"output,block"`
}

Arguments configures the otelcol.receiver.tcplog component.

func (Arguments) Convert

func (args Arguments) Convert() (otelcomponent.Config, error)

Convert implements receiver.Arguments, converting these Arguments into an OpenTelemetry Collector config object for the tcplogreceiver.

func (Arguments) DebugMetricsConfig

func (args Arguments) DebugMetricsConfig() otelcolCfg.DebugMetricsArguments

DebugMetricsConfig implements receiver.Arguments.

func (Arguments) Exporters

func (args Arguments) Exporters() map[pipeline.Signal]map[otelcomponent.ID]otelcomponent.Component

Exporters implements receiver.Arguments, returning exporters by signal type. This wrapper doesn't add any exporters internally; it defers to Output.

func (Arguments) Extensions

func (args Arguments) Extensions() map[otelcomponent.ID]otelcomponent.Component

Extensions implements receiver.Arguments, returning any needed extensions.

func (Arguments) NextConsumers

func (args Arguments) NextConsumers() *otelcol.ConsumerArguments

NextConsumers implements receiver.Arguments, returning the next consumer pipeline.

func (*Arguments) SetToDefault

func (args *Arguments) SetToDefault()

SetToDefault implements syntax.Defaulter, providing default values.

func (*Arguments) Validate

func (args *Arguments) Validate() error

Validate implements syntax.Validator for basic argument checks.

type MultilineConfig

type MultilineConfig struct {
	LineStartPattern string `alloy:"line_start_pattern,attr,optional"`
	LineEndPattern   string `alloy:"line_end_pattern,attr,optional"`
	OmitPattern      bool   `alloy:"omit_pattern,attr,optional"`
}

func (*MultilineConfig) Convert

func (c *MultilineConfig) Convert() *split.Config