journaldreceiver

README

Journald Receiver

Status
Stability	alpha
Supported pipeline types	logs
Distributions	contrib

Parses Journald events from systemd journal. Journald receiver is dependent on journalctl binary to be present and must be in the $PATH of the agent.

Configuration

Field	Default	Description
directory	/run/log/journal or /run/journal	A directory containing journal files to read entries from.
files		A list of journal files to read entries from
start_at	end	At startup, where to start reading logs from the file. Options are beginning or end
units	[ssh, kubelet, docker, containerd]	A list of units to read entries from
prioriry	info	Filter output by message priorities or priority ranges

Example Configurations

receivers:
  journald:
    directory: /run/log/journal
    units:
      - ssh
      - kubelet
      - docker
      - containerd
    priority: info

Documentation

Index

• func NewFactory() component.ReceiverFactory
• type JournaldConfig
• type ReceiverType
  • func (f ReceiverType) BaseConfig(cfg config.Receiver) adapter.BaseConfig
  • func (f ReceiverType) CreateDefaultConfig() config.Receiver
  • func (f ReceiverType) DecodeInputConfig(cfg config.Receiver) (*operator.Config, error)
  • func (f ReceiverType) Type() config.Type

Functions

func NewFactory

func NewFactory() component.ReceiverFactory

NewFactory creates a factory for journald receiver

Types

type JournaldConfig

type JournaldConfig struct {
	adapter.BaseConfig `mapstructure:",squash"`
	Input              adapter.InputConfig `mapstructure:",remain"`
}

JournaldConfig defines configuration for the journald receiver

type ReceiverType

type ReceiverType struct{}

ReceiverType implements adapter.LogReceiverType to create a journald receiver

func (ReceiverType) BaseConfig

func (f ReceiverType) BaseConfig(cfg config.Receiver) adapter.BaseConfig

BaseConfig gets the base config from config, for now

func (ReceiverType) CreateDefaultConfig

func (f ReceiverType) CreateDefaultConfig() config.Receiver

CreateDefaultConfig creates a config with type and version

func (ReceiverType) DecodeInputConfig

func (f ReceiverType) DecodeInputConfig(cfg config.Receiver) (*operator.Config, error)

DecodeInputConfig unmarshals the input operator

func (ReceiverType) Type

func (f ReceiverType) Type() config.Type

Type is the receiver type