istio: istio.io/istio/galley/pkg/config/analysis/diag Index | Files

package diag

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

Index

Package Files

level.go message.go messages.go

Constants

const DocPrefix = "https://istio.io/docs/reference/config/analysis"

DocPrefix is the root URL for validation message docs

Variables

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

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

    // 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.

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
}

Message is a specific diagnostic message

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) 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

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) 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.

Package diag imports 5 packages (graph) and is imported by 9 packages. Updated 2020-02-16. Refresh now. Tools for package owners.