package diag

import "istio.io/istio/galley/pkg/config/analysis/diag"

Index ¶

• Variables
• func GetAllLevelStrings() []string
• func GetUppercaseStringToLevelMap() map[string]Level
• func MockResource(name string) *resource.Instance
• type Level
• func GetAllLevels() []Level
• func (l Level) IsWorseThanOrEqualTo(target Level) bool
• func (l Level) String() string
• type Message
• func NewMessage(mt *MessageType, r *resource.Instance, p ...interface{}) Message
• func (m *Message) MarshalJSON() ([]byte, error)
• func (m *Message) Origin() string
• func (m Message) ReplaceLine(l string) string
• func (m *Message) String() string
• func (m *Message) Unstructured(includeOrigin bool) map[string]interface{}
• func (m *Message) UnstructuredAnalysisMessageBase() map[string]interface{}
• type MessageType
• func NewMessageType(level Level, code, template string) *MessageType
• func (m *MessageType) Code() string
• func (m *MessageType) Level() Level
• func (m *MessageType) Template() string
• type Messages
• func (ms *Messages) Add(m Message)
• func (ms *Messages) FilterOutLowerThan(outputLevel Level) Messages
• func (ms *Messages) SetDocRef(docRef string) *Messages
• func (ms *Messages) Sort()
• func (ms *Messages) SortedDedupedCopy() Messages

Package Files ¶

helper.go level.go message.go messages.go

Variables ¶

var (
    // Info level is for informational messages
    Info = Level{2, "Info"}

    // Warning level is for warning messages
    Warning = Level{1, "Warning"}

    // Error level is for error messages
    Error = Level{0, "Error"}
)

func GetAllLevelStrings ¶ Uses

func GetAllLevelStrings() []string

GetAllLevelStrings returns a list of strings representing the names of all Levels defined. The order is arbitrary but should be the same as GetAllLevels.

func GetUppercaseStringToLevelMap ¶ Uses

func GetUppercaseStringToLevelMap() map[string]Level

GetUppercaseStringToLevelMap returns a mapping of uppercase strings to Level structs. This function is intended to be used to convert user input to structs.

func MockResource ¶ Uses

func MockResource(name string) *resource.Instance

type Level ¶ Uses

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

Level is the severity level of a message.

func GetAllLevels ¶ Uses

func GetAllLevels() []Level

GetAllLevels returns an arbitrarily ordered slice of all Levels defined.

func (Level) IsWorseThanOrEqualTo ¶ Uses

func (l Level) IsWorseThanOrEqualTo(target Level) bool

func (Level) String ¶ Uses

func (l Level) String() string

type Message ¶ Uses

type Message struct {
    Type *MessageType

    // The Parameters to the message
    Parameters []interface{}

    // Resource is the underlying resource instance associated with the
    // message, or nil if no resource is associated with it.
    Resource *resource.Instance

    // DocRef is an optional reference tracker for the documentation URL
    DocRef string

    // Line is the line number of the error place in the message
    Line int
}

Message is a specific diagnostic message TODO: Implement using Analysis message API

func NewMessage ¶ Uses

func NewMessage(mt *MessageType, r *resource.Instance, p ...interface{}) Message

NewMessage returns a new Message instance from an existing type.

func (*Message) MarshalJSON ¶ Uses

func (m *Message) MarshalJSON() ([]byte, error)

MarshalJSON satisfies the Marshaler interface

func (*Message) Origin ¶ Uses

func (m *Message) Origin() string

Origin returns the origin of the message

func (Message) ReplaceLine ¶ Uses

func (m Message) ReplaceLine(l string) string

ReplaceLine replaces the line number from the input String method of Reference to the line number from Message

func (*Message) String ¶ Uses

func (m *Message) String() string

String implements io.Stringer

func (*Message) Unstructured ¶ Uses

func (m *Message) Unstructured(includeOrigin bool) map[string]interface{}

Unstructured returns this message as a JSON-style unstructured map

func (*Message) UnstructuredAnalysisMessageBase ¶ Uses

func (m *Message) UnstructuredAnalysisMessageBase() map[string]interface{}

UnstructuredAnalysisMessageBase returns this message as a JSON-style unstructured map in AnalaysisMessageBase TODO(jasonwzm): Remove once message implements AnalysisMessageBase

type MessageType ¶ Uses

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

MessageType is a type of diagnostic message

func NewMessageType ¶ Uses

func NewMessageType(level Level, code, template string) *MessageType

NewMessageType returns a new MessageType instance.

func (*MessageType) Code ¶ Uses

func (m *MessageType) Code() string

Code returns the code of the MessageType

func (*MessageType) Level ¶ Uses

func (m *MessageType) Level() Level

Level returns the level of the MessageType

func (*MessageType) Template ¶ Uses

func (m *MessageType) Template() string

Template returns the message template used by the MessageType

type Messages ¶ Uses

type Messages []Message

Messages is a slice of Message items.

func (*Messages) Add ¶ Uses

func (ms *Messages) Add(m Message)

Add a new message to the messages

func (*Messages) FilterOutLowerThan ¶ Uses

func (ms *Messages) FilterOutLowerThan(outputLevel Level) Messages

FilterOutLowerThan only keeps messages at or above the specified output level

func (*Messages) SetDocRef ¶ Uses

func (ms *Messages) SetDocRef(docRef string) *Messages

SetDocRef sets the doc URL reference tracker for the messages

func (*Messages) Sort ¶ Uses

func (ms *Messages) Sort()

Sort the message lexicographically by level, code, resource origin name, then string.

func (*Messages) SortedDedupedCopy ¶ Uses

func (ms *Messages) SortedDedupedCopy() Messages

SortedDedupedCopy returns a different sorted (and deduped) Messages struct.