logging

Documentation

Index

• type Bucket
• type Client
• type Histogram
• type Logs
• type Options
  • func NewLoggingOptions() *Options
  • func (s *Options) AddFlags(fs *pflag.FlagSet, c *Options)
  • func (s *Options) ApplyTo(options *Options)
  • func (s *Options) Validate() []error
• type Record
• type SearchFilter
• type Statistics

Types

type Bucket

type Bucket struct {
	Time  int64 `json:"time" description:"timestamp"`
	Count int64 `json:"count" description:"total number of logs at intervals"`
}

type Client

type Client interface {
	GetCurrentStats(sf SearchFilter) (Statistics, error)
	CountLogsByInterval(sf SearchFilter, interval string) (Histogram, error)
	SearchLogs(sf SearchFilter, from, size int64, order string) (Logs, error)
	ExportLogs(sf SearchFilter, w io.Writer) error
}

type Histogram

type Histogram struct {
	Total   int64    `json:"total" description:"total number of logs"`
	Buckets []Bucket `json:"histograms" description:"actual array of histogram results"`
}

Log count result by interval

type Logs

type Logs struct {
	Total   int64    `json:"total" description:"total number of matched results"`
	Records []Record `json:"records,omitempty" description:"actual array of results"`
}

Log search result

type Options

type Options struct {
	Host            string `json:"host" yaml:"host"`
	BasicAuth       bool   `json:"basicAuth" yaml:"basicAuth"`
	Username        string `json:"username" yaml:"username"`
	Password        string `json:"password" yaml:"password"`
	IndexPrefix     string `json:"indexPrefix,omitempty" yaml:"indexPrefix,omitempty"`
	Version         string `json:"version" yaml:"version"`
	ExportLogsLimit int    `json:"exportLogsLimit" yaml:"exportLogsLimit"`
}

func NewLoggingOptions

func NewLoggingOptions() *Options

func (*Options) AddFlags

func (s *Options) AddFlags(fs *pflag.FlagSet, c *Options)

func (*Options) ApplyTo

func (s *Options) ApplyTo(options *Options)

func (*Options) Validate

func (s *Options) Validate() []error

type Record

type Record struct {
	Log       string `json:"log,omitempty" description:"log message"`
	Time      string `json:"time,omitempty" description:"log timestamp"`
	Namespace string `json:"namespace,omitempty" description:"namespace"`
	Pod       string `json:"pod,omitempty" description:"pod name"`
	Container string `json:"container,omitempty" description:"container name"`
}

type SearchFilter

type SearchFilter struct {

	// To prevent disclosing archived logs of a reopened namespace,
	// NamespaceFilter records the namespace creation time.
	// Any query to this namespace must begin after its creation.
	NamespaceFilter map[string]*time.Time
	WorkloadSearch  []string
	WorkloadFilter  []string
	PodSearch       []string
	PodFilter       []string
	ContainerSearch []string
	ContainerFilter []string
	LogSearch       []string

	Starttime time.Time
	Endtime   time.Time
}

General query conditions

type Statistics

type Statistics struct {
	Containers int64 `json:"containers" description:"total number of containers"`
	Logs       int64 `json:"logs" description:"total number of logs"`
}

Log statistics result