types

Documentation

Index

• type Log
• type Rule

Types

type Log

type Log struct {
	Timestamp time.Time
	Message   string
}

Log is the log item returned by translator. It's very easy to extend this to support other log monitoring, such as docker log monitoring.

type Rule

type Rule struct {
	// Type is the type of matched problem.
	Type types.Type `json:"type"`
	// Condition is the type of the condition the problem triggered. Notice that
	// the Condition field should be set only when the problem is permanent, or
	// else the field will be ignored.
	Condition string `json:"condition"`
	// Reason is the short reason of the problem.
	Reason string `json:"reason"`
	// Pattern is the regular expression to match the problem in log.
	// Notice that the pattern must match to the end of the line.
	Pattern string `json:"pattern"`
	// PatternGeneratedMessageSuffix is an optional suffix appended to the matched pattern.
	// This suffix provides additional context or instructions for resolving the issue.
	// It can be used to include environment-specific details, links to documentation,
	// or any other information that helps users understand and address the problem.
	PatternGeneratedMessageSuffix string `json:"patternGeneratedMessageSuffix,omitempty"`
}

Rule describes how log monitor should analyze the log.