logutil

type ANSIEscapeSequenceStripper ¶

type ANSIEscapeSequenceStripper struct {
}

ANSIEscapeSequenceStripper removes ANSI escape sequences.

func (a *ANSIEscapeSequenceStripper) Convert(s string) string

type ColumnBoundary ¶ added in v0.52.8

type ColumnBoundary struct {
	Name  string
	Left  int
	Right int
}

ColumnBoundary defines the character indices bounding a single column.

type FallbackRawTextLogParser ¶

type FallbackRawTextLogParser struct{}

FallbackRawTextLogParser uses the given message directly as the result of main message of parsing structured message.

func (f *FallbackRawTextLogParser) TryParse(message string) *ParseStructuredLogResult

type JsonlTextParser ¶ added in v0.52.8

type JsonlTextParser struct{}

JsonlTextParser parses given JSONL formatted string.

func NewJsonlTextParser() *JsonlTextParser

func (j *JsonlTextParser) TryParse(originalMessage string) *ParseStructuredLogResult

type KLogTextParser ¶

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

KLogTextParser parses given klog formatted string. Example klog: I0929 08:20:24.205299 1949 kubelet_getters.go:219] "Pod status updated" pod="kube-system/kube-proxy-gke-p0-gke-basic-1-default-6400229f-0hgr" status="Running"

func NewKLogTextParser(hasHeader bool) *KLogTextParser

func (k *KLogTextParser) TryParse(message string) *ParseStructuredLogResult

type LogfmtTextParser ¶

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

LogfmtTextParser parses given logfmt formatted string. Reference: https://github.com/hynek/structlog/issues/511#issuecomment-1916426273

func NewLogfmtTextParser() *LogfmtTextParser

func (l *LogfmtTextParser) TryParse(message string) *ParseStructuredLogResult

type MultiTextLogParser ¶

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

func NewMultiTextLogParser(parsers ...StructuredLogParser) *MultiTextLogParser

func (m *MultiTextLogParser) TryParse(message string) *ParseStructuredLogResult

type ParseStructuredLogResult ¶

type ParseStructuredLogResult struct {
	Fields map[string]any
}

ParseStructuredLogResult represents the result of parsing a structured log message.

func (p *ParseStructuredLogResult) MainMessage() (string, error)

func (p *ParseStructuredLogResult) Raw() string

func (p *ParseStructuredLogResult) Severity() (enum.Severity, error)

func (p *ParseStructuredLogResult) StringField(field string) (string, error)

type RegexSequenceConverter ¶

type RegexSequenceConverter struct {
	// Regex is the regular expression to match.
	Regex *regexp.Regexp
	// Repl is the replacement string.
	Repl string
}

func MustNewRegexSequenceConverter(regex string, repl string) *RegexSequenceConverter

func NewRegexSequenceConverter(regex string, repl string) (*RegexSequenceConverter, error)

func (r *RegexSequenceConverter) Convert(s string) string

type SequenceConverter ¶

type SequenceConverter struct {
	// To is the replace result of any items in the From field.
	To string
	// From is the list of string to be replaced with the To field.
	From []string
}

SequenceConverter replaces specific sequences to a string.

func (c *SequenceConverter) Convert(s string) string

type SpecialSequenceConverter ¶

type SpecialSequenceConverter interface {
	// Convert receives the original string and returns the converted string.
	Convert(s string) string
}

SpecialSequenceConverter converts specific sequences from string to the other or removes them. (e.g ASCII escape characters, ANSI color characters)

type StructuredLogParser ¶

type StructuredLogParser interface {
	// TryParse attempts to parse the given message into *ParseStructuredLogResult.
	// It returns nil when the given message is not in the format.
	TryParse(message string) *ParseStructuredLogResult
}

StructuredLogParser is the interface to parse string represented structured logs like klog.

type TabulateLineType ¶ added in v0.52.8

type TabulateLineType int

TabulateLineType indicates the classified type of a line in a tabulate format.

const (
	// TabulateLineTypeUnknown represents an unrecognized or out-of-table line.
	TabulateLineTypeUnknown TabulateLineType = iota
	// TabulateLineTypeHeaderCandidate represents a line that looks like a table header.
	TabulateLineTypeHeaderCandidate
	// TabulateLineTypeSeparator represents a separator line (e.g., "--- ---").
	TabulateLineTypeSeparator
	// TabulateLineTypeBody represents a data row within a table.
	TabulateLineTypeBody
)

type TabulateParseResult ¶ added in v0.52.8

type TabulateParseResult struct {
	// Type classification of the processed line.
	Type TabulateLineType
	// Columns is populated for HeaderCandidate and Body types, representing the column names.
	Columns []string
	// Values contains the parsed key-value pairs for a Body line.
	Values map[string]string
}

TabulateParseResult holds the parsing result of a single line.

type TabulateReader ¶ added in v0.52.8

type TabulateReader struct {
	ColumnBoundaries []ColumnBoundary
	Headers          []string
}

TabulateReader is a stateful reader for space-padded tabulate tables. It tracks headers and vertical column boundaries dynamically.

func NewTabulateReader() *TabulateReader

func (r *TabulateReader) ParseLine(line string) (*TabulateParseResult, error)

func (r *TabulateReader) Reset()

type UnicodeUnquoteConverter ¶

type UnicodeUnquoteConverter struct{}

UnicodeUnquoteConverter replaces escaped unicode characters like `\\xe2\\x80\\xa6` into the corresponded unicode string.

func (u *UnicodeUnquoteConverter) Convert(s string) string