syslog

Documentation

Overview

Package syslog provides an otelcol.receiver.syslog 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]otelextension.Extension
  • func (args Arguments) NextConsumers() *otelcol.ConsumerArguments
  • func (args *Arguments) SetToDefault()
  • func (args *Arguments) Validate() error
• type AsyncConfig
  • func (c *AsyncConfig) Convert() *stanzainputudp.AsyncConfig
• type FramingTrailer
  • func (s FramingTrailer) MarshalText() (text []byte, err error)
  • func (s *FramingTrailer) UnmarshalText(text []byte) error
• type MultilineConfig
  • func (c *MultilineConfig) Convert() *split.Config
• type TCP
• type TrimConfig
  • func (c *TrimConfig) Convert() *trim.Config
• type UDP

Types

type Arguments

type Arguments struct {
	Protocol                     config.SysLogFormat `alloy:"protocol,attr,optional"`
	Location                     string              `alloy:"location,attr,optional"`
	EnableOctetCounting          bool                `alloy:"enable_octet_counting,attr,optional"`
	MaxOctets                    int                 `alloy:"max_octets,attr,optional"`
	AllowSkipPriHeader           bool                `alloy:"allow_skip_pri_header,attr,optional"`
	NonTransparentFramingTrailer *FramingTrailer     `alloy:"non_transparent_framing_trailer,attr,optional"`

	ConsumerRetry otelcol.ConsumerRetryArguments `alloy:"retry_on_failure,block,optional"`
	TCP           *TCP                           `alloy:"tcp,block,optional"`
	UDP           *UDP                           `alloy:"udp,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.syslog component.

func (Arguments) Convert

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

Convert implements receiver.Arguments.

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.

func (Arguments) Extensions

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

Extensions implements receiver.Arguments.

func (Arguments) NextConsumers

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

NextConsumers implements receiver.Arguments.

func (*Arguments) SetToDefault

func (args *Arguments) SetToDefault()

SetToDefault implements syntax.Defaulter.

func (*Arguments) Validate

func (args *Arguments) Validate() error

Validate implements syntax.Validator.

type AsyncConfig

type AsyncConfig struct {
	Readers        int `alloy:"readers,attr,optional"`
	Processors     int `alloy:"processors,attr,optional"`
	MaxQueueLength int `alloy:"max_queue_length,attr,optional"`
}

func (*AsyncConfig) Convert

func (c *AsyncConfig) Convert() *stanzainputudp.AsyncConfig

type FramingTrailer

type FramingTrailer string

var LFTrailer FramingTrailer = "LF"

var NULTrailer FramingTrailer = "NUL"

func (FramingTrailer) MarshalText

func (s FramingTrailer) MarshalText() (text []byte, err error)

MarshalText implements encoding.TextMarshaler

func (*FramingTrailer) UnmarshalText

func (s *FramingTrailer) UnmarshalText(text []byte) error

UnmarshalText implements encoding.TextUnmarshaler

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

type TCP

type TCP struct {
	MaxLogSize      units.Base2Bytes            `alloy:"max_log_size,attr,optional"`
	ListenAddress   string                      `alloy:"listen_address,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"`
	TrimConfig      *TrimConfig                 `alloy:",squash"`
}

type TrimConfig

type TrimConfig struct {
	PreserveLeadingWhitespace  bool `alloy:"preserve_leading_whitespaces,attr,optional"`
	PreserveTrailingWhitespace bool `alloy:"preserve_trailing_whitespaces,attr,optional"`
}

func (*TrimConfig) Convert

func (c *TrimConfig) Convert() *trim.Config

type UDP

type UDP struct {
	ListenAddress   string           `alloy:"listen_address,attr,optional"`
	OneLogPerPacket bool             `alloy:"one_log_per_packet,attr,optional"`
	AddAttributes   bool             `alloy:"add_attributes,attr,optional"`
	Encoding        string           `alloy:"encoding,attr,optional"`
	MultilineConfig *MultilineConfig `alloy:"multiline,block,optional"`
	TrimConfig      *TrimConfig      `alloy:",squash"`
	Async           *AsyncConfig     `alloy:"async,block,optional"`
}