syslog

Documentation

Index

• Variables
• type Arguments
• type Component
  • func New(o component.Options, args Arguments) (*Component, error)
  • func (c *Component) DebugInfo() interface{}
  • func (c *Component) Run(ctx context.Context) error
  • func (c *Component) Update(args component.Arguments) error
• type ListenerConfig
  • func (sc ListenerConfig) Convert() *scrapeconfig.SyslogTargetConfig
  • func (sc *ListenerConfig) SetToDefault()
  • func (sc *ListenerConfig) Validate() error

Variables

var DefaultListenerConfig = ListenerConfig{
	ListenProtocol:   st.DefaultProtocol,
	IdleTimeout:      st.DefaultIdleTimeout,
	MaxMessageLength: st.DefaultMaxMessageLength,
}

DefaultListenerConfig provides the default arguments for a syslog listener.

Types

type Arguments

type Arguments struct {
	SyslogListeners []ListenerConfig    `river:"listener,block"`
	ForwardTo       []loki.LogsReceiver `river:"forward_to,attr"`
	RelabelRules    flow_relabel.Rules  `river:"relabel_rules,attr,optional"`
}

Arguments holds values which are used to configure the loki.source.syslog component.

type Component

type Component struct {
	// contains filtered or unexported fields
}

Component implements the loki.source.syslog component.

func New

func New(o component.Options, args Arguments) (*Component, error)

New creates a new loki.source.syslog component.

func (*Component) DebugInfo

func (c *Component) DebugInfo() interface{}

DebugInfo returns information about the status of listeners.

func (*Component) Run

func (c *Component) Run(ctx context.Context) error

Run implements component.Component.

func (*Component) Update

func (c *Component) Update(args component.Arguments) error

Update implements component.Component.

type ListenerConfig

type ListenerConfig struct {
	ListenAddress        string            `river:"address,attr"`
	ListenProtocol       string            `river:"protocol,attr,optional"`
	IdleTimeout          time.Duration     `river:"idle_timeout,attr,optional"`
	LabelStructuredData  bool              `river:"label_structured_data,attr,optional"`
	Labels               map[string]string `river:"labels,attr,optional"`
	UseIncomingTimestamp bool              `river:"use_incoming_timestamp,attr,optional"`
	UseRFC5424Message    bool              `river:"use_rfc5424_message,attr,optional"`
	MaxMessageLength     int               `river:"max_message_length,attr,optional"`
	TLSConfig            config.TLSConfig  `river:"tls_config,block,optional"`
}

ListenerConfig defines a syslog listener.

func (ListenerConfig) Convert

func (sc ListenerConfig) Convert() *scrapeconfig.SyslogTargetConfig

Convert is used to bridge between the River and Promtail types.

func (*ListenerConfig) SetToDefault

func (sc *ListenerConfig) SetToDefault()

SetToDefault implements river.Defaulter.

func (*ListenerConfig) Validate

func (sc *ListenerConfig) Validate() error

Validate implements river.Validator.