log

Documentation

Index

• type API
• type Args
• type Entry
• type Info
  • func (l Info) Mask() uint64
  • func (l Info) SendLog(node string, logKind madmin.LogMask) bool
• type ObjectVersion
• type Trace

Types

type API

type API struct {
	Name string `json:"name,omitempty"`
	Args *Args  `json:"args,omitempty"`
}

API - defines the api type and its args.

type Args

type Args struct {
	Bucket    string            `json:"bucket,omitempty"`
	Object    string            `json:"object,omitempty"`
	VersionID string            `json:"versionId,omitempty"`
	Objects   []ObjectVersion   `json:"objects,omitempty"`
	Metadata  map[string]string `json:"metadata,omitempty"`
}

Args - defines the arguments for the API.

type Entry

type Entry struct {
	DeploymentID string         `json:"deploymentid,omitempty"`
	Level        madmin.LogKind `json:"level"`
	LogKind      madmin.LogKind `json:"errKind,omitempty"` // Deprecated Jan 2024
	Time         time.Time      `json:"time"`
	API          *API           `json:"api,omitempty"`
	RemoteHost   string         `json:"remotehost,omitempty"`
	Host         string         `json:"host,omitempty"`
	RequestID    string         `json:"requestID,omitempty"`
	UserAgent    string         `json:"userAgent,omitempty"`
	Message      string         `json:"message,omitempty"`
	Trace        *Trace         `json:"error,omitempty"`
}

Entry - defines fields and values of each log entry.

type Info

type Info struct {
	Entry
	ConsoleMsg string
	NodeName   string `json:"node"`
	Err        error  `json:"-"`
}

Info holds console log messages

func (Info) Mask

func (l Info) Mask() uint64

Mask returns the mask based on the error level.

func (Info) SendLog

func (l Info) SendLog(node string, logKind madmin.LogMask) bool

SendLog returns true if log pertains to node specified in args.

type ObjectVersion

type ObjectVersion struct {
	ObjectName string `json:"objectName"`
	VersionID  string `json:"versionId,omitempty"`
}

ObjectVersion object version key/versionId

type Trace

type Trace struct {
	Message   string                 `json:"message,omitempty"`
	Source    []string               `json:"source,omitempty"`
	Variables map[string]interface{} `json:"variables,omitempty"`
}

Trace - defines the trace.