dmesg

Documentation

Overview

Package dmesg provides the functionality to poll the dmesg log.

Index

• Constants
• Variables
• func ParseCtimeWithError(line []byte) (time.Time, []byte, error)
• func ParseISOtimeWithError(line []byte) (time.Time, []byte, error)
• func ParseShortISOtimeWithError(line []byte) (time.Time, []byte, error)
• type LogLine
  • func ParseDmesgLine(line string) LogLine
  • func (l LogLine) IsEmpty() bool
• type LogLineProcessor
  • func NewLogLineProcessor(ctx context.Context, dmesgWatcher Watcher, matchFunc MatchFunc, ...) (*LogLineProcessor, error)
  • func (w *LogLineProcessor) Close()
  • func (w *LogLineProcessor) Get(ctx context.Context, since time.Time) ([]components.Event, error)
• type MatchFunc
• type Watcher
  • func NewWatcher() (Watcher, error)
  • func NewWatcherWithCommands(cmds [][]string) (Watcher, error)

Constants

const (
	DefaultCacheExpiration    = 5 * time.Minute
	DefaultCachePurgeInterval = 10 * time.Minute
)

const EventKeyLogLine = "log_line"

Variables

var DefaultDmesgScanCommands = [][]string{
	{"dmesg --decode --time-format=iso --nopager --buffer-size 163920"},
}

var DefaultWatchCommands = [][]string{
	{"dmesg --decode --time-format=iso --nopager --buffer-size 163920 -w || true"},

	{"dmesg --decode --time-format=iso --nopager --buffer-size 163920 || true"},

	{"dmesg --decode --time-format=iso --nopager --buffer-size 163920 -W || true"},
}

Functions

func ParseCtimeWithError

func ParseCtimeWithError(line []byte) (time.Time, []byte, error)

ParseCtimeWithError Parses the timestamp from "dmesg --ctime" output lines. Returns a zero time if the timestamp is not found or the timestamp is invalid. Returns an error if the timestamp is not found or the timestamp is invalid.

func ParseISOtimeWithError

func ParseISOtimeWithError(line []byte) (time.Time, []byte, error)

ParseISOtimeWithError parses the timestamp from "dmesg --time-format=iso" output lines. ref. "The definition of the iso timestamp is: YYYY-MM-DD<T>HH:MM:SS,<microseconds>←+><timezone offset from UTC>."

func ParseShortISOtimeWithError

func ParseShortISOtimeWithError(line []byte) (time.Time, []byte, error)

ParseShortISOtimeWithError parses the timestamp from "journalctl -o short-iso" output lines.

Types

type LogLine

type LogLine struct {
	Timestamp time.Time
	Facility  string
	Level     string
	Content   string

	// Error is set when a dmesg command fails.
	Error string
}

func ParseDmesgLine

func ParseDmesgLine(line string) LogLine

parses the timestamp from "dmesg --time-format=iso" output lines. "The definition of the iso timestamp is: YYYY-MM-DD<T>HH:MM:SS,<microseconds>←+><timezone offset from UTC>."

func (LogLine) IsEmpty

func (l LogLine) IsEmpty() bool

type LogLineProcessor

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

func NewLogLineProcessor

func NewLogLineProcessor(ctx context.Context, dmesgWatcher Watcher, matchFunc MatchFunc, eventsStore events_db.Store) (*LogLineProcessor, error)

Creates a new log line processor where it streams logs from the dmesg watcher, uses the match function, and inserts the events into the events store. If the dmesg watcher is not provided, it will create a default one.

func (*LogLineProcessor) Close

func (w *LogLineProcessor) Close()

func (*LogLineProcessor) Get

func (w *LogLineProcessor) Get(ctx context.Context, since time.Time) ([]components.Event, error)

Returns the event in the descending order of timestamp (latest event first).

type MatchFunc

type MatchFunc func(line string) (eventName string, message string)

type Watcher

type Watcher interface {
	// Watch returns a channel that emits log lines.
	// The channel is closed on (1) process exit, (2) on calling "Close" method
	Watch() <-chan LogLine
	// Closes the existing/ongoing watch/stream routines.
	// Safe to call multiple times.
	Close()
}

func NewWatcher

func NewWatcher() (Watcher, error)

func NewWatcherWithCommands

func NewWatcherWithCommands(cmds [][]string) (Watcher, error)