report

Documentation

Overview

Package report contains functions that process kernel output, detect/extract crash messages, symbolize them, etc.

Index

• func Fuzz(data []byte) int
• func IsSuppressed(reporter Reporter, output []byte) bool
• type Report
• type Reporter
  • func NewReporter(cfg *mgrconfig.Config) (Reporter, error)
• type Type
  • func (t Type) String() string

Functions

func Fuzz

func Fuzz(data []byte) int

func IsSuppressed

func IsSuppressed(reporter Reporter, output []byte) bool

Types

type Report

type Report struct {
	// Title contains a representative description of the first oops.
	Title string
	// Bug type (e.g. hang, memory leak, etc).
	Type Type
	// The indicative function name.
	Frame string
	// Report contains whole oops text.
	Report []byte
	// Output contains whole raw console output as passed to Reporter.Parse.
	Output []byte
	// StartPos/EndPos denote region of output with oops message(s).
	StartPos int
	EndPos   int
	// Suppressed indicates whether the report should not be reported to user.
	Suppressed bool
	// Corrupted indicates whether the report is truncated of corrupted in some other way.
	Corrupted bool
	// CorruptedReason contains reason why the report is marked as corrupted.
	CorruptedReason string
	// Maintainers is list of maintainer emails (filled in by Symbolize).
	Maintainers []string
	// contains filtered or unexported fields
}

type Reporter

type Reporter interface {
	// ContainsCrash searches kernel console output for oops messages.
	ContainsCrash(output []byte) bool

	// Parse extracts information about oops from console output.
	// Returns nil if no oops found.
	Parse(output []byte) *Report

	// Symbolize symbolizes rep.Report and fills in Maintainers.
	Symbolize(rep *Report) error
}

func NewReporter

func NewReporter(cfg *mgrconfig.Config) (Reporter, error)

NewReporter creates reporter for the specified OS/Type.

type Type

type Type int

const (
	Unknown Type = iota
	Hang
	MemoryLeak
	UnexpectedReboot
)

func (Type) String

func (t Type) String() string