config

Documentation

Overview

Package config is a generated protocol buffer package.

The `stdio` adapter enables Istio to output logs and metrics to the local machine. Logs and metrics can be directed to Mixer's standard output stream, standard error stream, or to any locally reachable file. When outputting to files, you can enable file rotation such that the adapter will automatically manage a set of file backups as data is generated.

This adapter supports the [logentry template](https://istio.io/docs/reference/config/policy-and-telemetry/templates/logentry/). and the [metric template](https://istio.io/docs/reference/config/policy-and-telemetry/templates/metric/).

It is generated from these files:

mixer/adapter/stdio/config/config.proto

It has these top-level messages:

Params

Index

• Variables
• type Params
  • func (*Params) Descriptor() ([]byte, []int)
  • func (m *Params) Marshal() (dAtA []byte, err error)
  • func (m *Params) MarshalTo(dAtA []byte) (int, error)
  • func (*Params) ProtoMessage()
  • func (m *Params) Reset()
  • func (m *Params) Size() (n int)
  • func (this *Params) String() string
  • func (m *Params) Unmarshal(dAtA []byte) error
• type Params_Level
  • func (Params_Level) EnumDescriptor() ([]byte, []int)
  • func (x Params_Level) String() string
• type Params_Stream
  • func (Params_Stream) EnumDescriptor() ([]byte, []int)
  • func (x Params_Stream) String() string

Variables

var (
	ErrInvalidLengthConfig = fmt.Errorf("proto: negative length found during unmarshaling")
	ErrIntOverflowConfig   = fmt.Errorf("proto: integer overflow")
)

var Params_Level_name = map[int32]string{
	0: "INFO",
	1: "WARNING",
	2: "ERROR",
}

var Params_Level_value = map[string]int32{
	"INFO":    0,
	"WARNING": 1,
	"ERROR":   2,
}

var Params_Stream_name = map[int32]string{
	0: "STDOUT",
	1: "STDERR",
	2: "FILE",
	3: "ROTATED_FILE",
}

var Params_Stream_value = map[string]int32{
	"STDOUT":       0,
	"STDERR":       1,
	"FILE":         2,
	"ROTATED_FILE": 3,
}

Types

type Params

type Params struct {
	// Selects which standard stream to write to for log entries.
	// STDERR is the default Stream.
	LogStream Params_Stream `` /* 129-byte string literal not displayed */
	// Maps from severity strings as specified in LogEntry instances to
	// the set of levels supported by this adapter. This defaults to a map of
	//
	// “`
	// "INFORMATIONAL" : INFO,
	// "informational" : INFO,
	// "INFO" : INFO,
	// "info" : INFO,
	// "WARNING" : WARNING,
	// "warning" : WARNING,
	// "WARN": WARNING,
	// "warning": WARNING,
	// "ERROR": ERROR,
	// "error": ERROR,
	// "ERR": ERROR,
	// "err": ERROR,
	// "FATAL": ERROR,
	// "fatal": ERROR,
	// “`
	SeverityLevels map[string]Params_Level `` /* 224-byte string literal not displayed */
	// The level to assign to metrics being output. Defaults to INFO.
	MetricLevel Params_Level `` /* 134-byte string literal not displayed */
	// Whether to output a console-friendly or json-friendly format. Defaults to true.
	OutputAsJson bool `protobuf:"varint,4,opt,name=output_as_json,json=outputAsJson,proto3" json:"output_as_json,omitempty"`
	// The minimum level to output, anything less than this level is ignored. Defaults to INFO (everything).
	OutputLevel Params_Level `` /* 134-byte string literal not displayed */
	// The file system path when outputting to a file or rotating file.
	//
	// When using rotated log files, this path is used as a foundational path. This is where log
	// output is normally saved. When a rotation needs to take place because the file got too big
	// or too old, then the file is renamed by appending a timestamp to the name. Such renamed
	// files are called backups. Once a backup has been created, output resumes to this path.
	OutputPath string `protobuf:"bytes,6,opt,name=output_path,json=outputPath,proto3" json:"output_path,omitempty"`
	// The maximum size in megabytes of a log file before it gets
	// rotated. It defaults to 100 megabytes.
	MaxMegabytesBeforeRotation int32 `` /* 144-byte string literal not displayed */
	// The maximum number of days to retain old rotated log files based on the
	// timestamp encoded in their filename. Note that a day is defined as 24
	// hours and may not exactly correspond to calendar days due to daylight
	// savings, leap seconds, etc. The default is to remove log files
	// older than 30 days. 0 indicates no limit.
	MaxDaysBeforeRotation int32 `` /* 129-byte string literal not displayed */
	// The maximum number of old rotated log files to retain.  The default
	// is to retain at most 1000 logs. 0 indicates no limit.
	MaxRotatedFiles int32 `protobuf:"varint,9,opt,name=max_rotated_files,json=maxRotatedFiles,proto3" json:"max_rotated_files,omitempty"`
}

Configuration format for the `stdio` adapter

func (*Params) Descriptor

func (*Params) Descriptor() ([]byte, []int)

func (*Params) Marshal

func (m *Params) Marshal() (dAtA []byte, err error)

func (*Params) MarshalTo

func (m *Params) MarshalTo(dAtA []byte) (int, error)

func (*Params) ProtoMessage

func (*Params) ProtoMessage()

func (*Params) Reset

func (m *Params) Reset()

func (*Params) Size

func (m *Params) Size() (n int)

func (*Params) String

func (this *Params) String() string

func (*Params) Unmarshal

func (m *Params) Unmarshal(dAtA []byte) error

type Params_Level

type Params_Level int32

Importance level for individual items output by this adapter.

const (
	INFO    Params_Level = 0
	WARNING Params_Level = 1
	ERROR   Params_Level = 2
)

func (Params_Level) EnumDescriptor

func (Params_Level) EnumDescriptor() ([]byte, []int)

func (Params_Level) String

func (x Params_Level) String() string

type Params_Stream

type Params_Stream int32

Stream is used to select between different log output sinks.

const (
	// Output to the Mixer process' standard output stream. This is the default value.
	STDOUT Params_Stream = 0
	// Output to the Mixer process' standard error stream.
	STDERR Params_Stream = 1
	// Output to a specific file.
	FILE Params_Stream = 2
	// Output to a specific rotating file, controlled by the various file rotation options.
	ROTATED_FILE Params_Stream = 3
)

func (Params_Stream) EnumDescriptor

func (Params_Stream) EnumDescriptor() ([]byte, []int)

func (Params_Stream) String

func (x Params_Stream) String() string