syslog

Documentation

Index

• type ConnPipe
  • func NewConnPipe(addr net.Addr) *ConnPipe
  • func (pipe *ConnPipe) Close() error
• type Metrics
  • func NewMetrics(reg prometheus.Registerer) *Metrics
• type SyslogTarget
  • func NewSyslogTarget(metrics *Metrics, logger log.Logger, handler api.EntryHandler, ...) (*SyslogTarget, error)
  • func (t *SyslogTarget) Details() interface{}
  • func (t *SyslogTarget) DiscoveredLabels() model.LabelSet
  • func (t *SyslogTarget) Labels() model.LabelSet
  • func (t *SyslogTarget) ListenAddress() net.Addr
  • func (t *SyslogTarget) Ready() bool
  • func (t *SyslogTarget) Stop() error
  • func (t *SyslogTarget) Type() target.TargetType
• type SyslogTargetManager
  • func NewSyslogTargetManager(metrics *Metrics, logger log.Logger, client api.EntryHandler, ...) (*SyslogTargetManager, error)
  • func (tm *SyslogTargetManager) ActiveTargets() map[string][]target.Target
  • func (tm *SyslogTargetManager) AllTargets() map[string][]target.Target
  • func (tm *SyslogTargetManager) Ready() bool
  • func (tm *SyslogTargetManager) Stop()
• type TCPTransport
  • func (t *TCPTransport) Addr() net.Addr
  • func (t *TCPTransport) Close() error
  • func (t TCPTransport) Ready() bool
  • func (t *TCPTransport) Run() error
  • func (t *TCPTransport) Wait()
• type Transport
  • func NewSyslogTCPTransport(config *scrapeconfig.SyslogTargetConfig, handleMessage handleMessage, ...) Transport
  • func NewSyslogUDPTransport(config *scrapeconfig.SyslogTargetConfig, handleMessage handleMessage, ...) Transport
• type UDPTransport
  • func (t *UDPTransport) Addr() net.Addr
  • func (t *UDPTransport) Close() error
  • func (t UDPTransport) Ready() bool
  • func (t *UDPTransport) Run() error
  • func (t *UDPTransport) Wait()

Types

type ConnPipe

type ConnPipe struct {
	*io.PipeReader
	*io.PipeWriter
	// contains filtered or unexported fields
}

func NewConnPipe

func NewConnPipe(addr net.Addr) *ConnPipe

func (*ConnPipe) Close

func (pipe *ConnPipe) Close() error

type Metrics

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

Metrics holds a set of syslog metrics.

func NewMetrics

func NewMetrics(reg prometheus.Registerer) *Metrics

NewMetrics creates a new set of syslog metrics. If reg is non-nil, the metrics will be registered.

type SyslogTarget

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

SyslogTarget listens to syslog messages. nolint:revive

func NewSyslogTarget

func NewSyslogTarget(
	metrics *Metrics,
	logger log.Logger,
	handler api.EntryHandler,
	relabel []*relabel.Config,
	config *scrapeconfig.SyslogTargetConfig,
) (*SyslogTarget, error)

NewSyslogTarget configures a new SyslogTarget.

func (*SyslogTarget) Details

func (t *SyslogTarget) Details() interface{}

Details returns target-specific details.

func (*SyslogTarget) DiscoveredLabels

func (t *SyslogTarget) DiscoveredLabels() model.LabelSet

DiscoveredLabels returns the set of labels discovered by the syslog target, which is always nil. Implements Target.

func (*SyslogTarget) Labels

func (t *SyslogTarget) Labels() model.LabelSet

Labels returns the set of labels that statically apply to all log entries produced by the SyslogTarget.

func (*SyslogTarget) ListenAddress

func (t *SyslogTarget) ListenAddress() net.Addr

ListenAddress returns the address SyslogTarget is listening on.

func (*SyslogTarget) Ready

func (t *SyslogTarget) Ready() bool

Ready indicates whether or not the syslog target is ready to be read from.

func (*SyslogTarget) Stop

func (t *SyslogTarget) Stop() error

Stop shuts down the SyslogTarget.

func (*SyslogTarget) Type

func (t *SyslogTarget) Type() target.TargetType

Type returns SyslogTargetType.

type SyslogTargetManager

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

SyslogTargetManager manages a series of SyslogTargets. nolint:revive

func NewSyslogTargetManager

func NewSyslogTargetManager(
	metrics *Metrics,
	logger log.Logger,
	client api.EntryHandler,
	scrapeConfigs []scrapeconfig.Config,
) (*SyslogTargetManager, error)

NewSyslogTargetManager creates a new SyslogTargetManager.

func (*SyslogTargetManager) ActiveTargets

func (tm *SyslogTargetManager) ActiveTargets() map[string][]target.Target

ActiveTargets returns the list of SyslogTargets where syslog data is being read. ActiveTargets is an alias to AllTargets as SyslogTargets cannot be deactivated, only stopped.

func (*SyslogTargetManager) AllTargets

func (tm *SyslogTargetManager) AllTargets() map[string][]target.Target

AllTargets returns the list of all targets where syslog data is currently being read.

func (*SyslogTargetManager) Ready

func (tm *SyslogTargetManager) Ready() bool

Ready returns true if at least one SyslogTarget is also ready.

func (*SyslogTargetManager) Stop

func (tm *SyslogTargetManager) Stop()

Stop stops the SyslogTargetManager and all of its SyslogTargets.

type TCPTransport

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

func (*TCPTransport) Addr

func (t *TCPTransport) Addr() net.Addr

Addr implements SyslogTransport

func (*TCPTransport) Close

func (t *TCPTransport) Close() error

Close implements SyslogTransport

func (TCPTransport) Ready

func (t TCPTransport) Ready() bool

Ready implements SyslogTransport

func (*TCPTransport) Run

func (t *TCPTransport) Run() error

Run implements SyslogTransport

func (*TCPTransport) Wait

func (t *TCPTransport) Wait()

Wait implements SyslogTransport

type Transport

type Transport interface {
	Run() error
	Addr() net.Addr
	Ready() bool
	Close() error
	Wait()
}

func NewSyslogTCPTransport

func NewSyslogTCPTransport(config *scrapeconfig.SyslogTargetConfig, handleMessage handleMessage, handleError handleMessageError, logger log.Logger) Transport

func NewSyslogUDPTransport

func NewSyslogUDPTransport(config *scrapeconfig.SyslogTargetConfig, handleMessage handleMessage, handleError handleMessageError, logger log.Logger) Transport

type UDPTransport

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

func (*UDPTransport) Addr

func (t *UDPTransport) Addr() net.Addr

Addr implements SyslogTransport

func (*UDPTransport) Close

func (t *UDPTransport) Close() error

Close implements SyslogTransport

func (UDPTransport) Ready

func (t UDPTransport) Ready() bool

Ready implements SyslogTransport

func (*UDPTransport) Run

func (t *UDPTransport) Run() error

Run implements SyslogTransport

func (*UDPTransport) Wait

func (t *UDPTransport) Wait()

Wait implements SyslogTransport