source

Documentation

Index

• Constants
• type LazyLogEntries
  • func (entries LazyLogEntries) Filter(term string) (LazyLogEntries, error)
  • func (entries LazyLogEntries) Len() int
  • func (entries LazyLogEntries) Row(cfg *config.Config, i int) table.Row
• type LazyLogEntry
  • func (e LazyLogEntry) Length() int
  • func (e LazyLogEntry) Line(file *os.File) (json.RawMessage, error)
  • func (e LazyLogEntry) LogEntry(file *os.File, cfg *config.Config) LogEntry
• type Level
  • func ParseLevel(value string, customMapping map[string]string) Level
  • func (l Level) String() string
• type LogEntry
  • func (e LogEntry) Row() table.Row
• type Source
  • func File(name string, cfg *config.Config) (*Source, error)
  • func Reader(input io.Reader, cfg *config.Config) (*Source, error)
  • func (s *Source) CanFollow() bool
  • func (s *Source) Close() error
  • func (s *Source) ParseLogEntries() (LazyLogEntries, error)
  • func (s *Source) StartStreaming(ctx context.Context, send func(msg LazyLogEntries, err error))

Constants

const (
	ErrFileTruncated semerr.Error = "file truncated"
)

const (

	// RefreshInterval is an interval of refreshing logs.
	RefreshInterval = 200 * time.Millisecond
)

Types

type LazyLogEntries

type LazyLogEntries struct {
	Seeker  *os.File
	Entries []LazyLogEntry
}

LazyLogEntries is a helper type definition for the slice of lazy log entries.

func (LazyLogEntries) Filter

func (entries LazyLogEntries) Filter(term string) (LazyLogEntries, error)

Filter filters entries by ignore case exact match.

func (LazyLogEntries) Len

func (entries LazyLogEntries) Len() int

func (LazyLogEntries) Row

func (entries LazyLogEntries) Row(cfg *config.Config, i int) table.Row

Row returns table.Row representation of the log entry.

type LazyLogEntry

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

LazyLogEntry holds unredenred LogEntry. Use `LogEntry` getter.

func (LazyLogEntry) Length

func (e LazyLogEntry) Length() int

Length of the entry.

func (LazyLogEntry) Line

func (e LazyLogEntry) Line(file *os.File) (json.RawMessage, error)

Line re-reads the line.

func (LazyLogEntry) LogEntry

func (e LazyLogEntry) LogEntry(file *os.File, cfg *config.Config) LogEntry

LogEntry parses and returns `LogEntry`.

type Level

type Level string

Level of the logs entity.

const (
	LevelUnknown Level = "none"
	LevelTrace   Level = "trace"
	LevelDebug   Level = "debug"
	LevelInfo    Level = "info"
	LevelWarning Level = "warn"
	LevelError   Level = "error"
	LevelPanic   Level = "panic"
	LevelFatal   Level = "fatal"
)

Possible log levels.

func ParseLevel

func ParseLevel(value string, customMapping map[string]string) Level

ParseLevel parses level from the text value.

nolint: cyclop // Switch-case.

func (Level) String

func (l Level) String() string

String implement fmt.Stringer interface.

type LogEntry

type LogEntry struct {
	Fields []string
	Line   json.RawMessage
	Error  error
}

LogEntry is a single partly-parse record of the log.

func (LogEntry) Row

func (e LogEntry) Row() table.Row

Row returns table.Row representation of the log entry.

type Source

type Source struct {
	// Seeker is used to do random access reads from the file.
	Seeker *os.File
	// contains filtered or unexported fields
}

func File

func File(name string, cfg *config.Config) (*Source, error)

File creates a new Source for reading log entries from a file.

func Reader

func Reader(input io.Reader, cfg *config.Config) (*Source, error)

Reader creates a new Source for reading log entries from an io.Reader. This will write the input to a temp file, which will be used to seek against.

func (*Source) CanFollow

func (s *Source) CanFollow() bool

func (*Source) Close

func (s *Source) Close() error

Close implements io.Closer.

It closes and removes temporary files.

func (*Source) ParseLogEntries

func (s *Source) ParseLogEntries() (LazyLogEntries, error)

func (*Source) StartStreaming

func (s *Source) StartStreaming(ctx context.Context, send func(msg LazyLogEntries, err error))

StartStreaming synchronizes log entries with the file and sends them to the channel.