logentry

Documentation

Overview

Package logentry is a generated protocol buffer package.

It is generated from these files:

bazel-out/local-fastbuild/genfiles/mixer/template/logentry/go_default_library_tmpl.proto

It has these top-level messages:

Type
InstanceParam

Index

• Constants
• Variables
• type Handler
• type HandlerBuilder
• type Instance
• type InstanceParam
  • func (*InstanceParam) Descriptor() ([]byte, []int)
  • func (this *InstanceParam) Equal(that interface{}) bool
  • func (m *InstanceParam) GetMonitoredResourceDimensions() map[string]string
  • func (m *InstanceParam) GetMonitoredResourceType() string
  • func (m *InstanceParam) GetSeverity() string
  • func (m *InstanceParam) GetTimestamp() string
  • func (m *InstanceParam) GetVariables() map[string]string
  • func (this *InstanceParam) GoString() string
  • func (m *InstanceParam) Marshal() (dAtA []byte, err error)
  • func (m *InstanceParam) MarshalTo(dAtA []byte) (int, error)
  • func (*InstanceParam) ProtoMessage()
  • func (m *InstanceParam) Reset()
  • func (m *InstanceParam) Size() (n int)
  • func (this *InstanceParam) String() string
  • func (m *InstanceParam) Unmarshal(dAtA []byte) error
• type Type
  • func (*Type) Descriptor() ([]byte, []int)
  • func (this *Type) Equal(that interface{}) bool
  • func (m *Type) GetMonitoredResourceDimensions() map[string]istio_mixer_v1_config_descriptor.ValueType
  • func (m *Type) GetVariables() map[string]istio_mixer_v1_config_descriptor.ValueType
  • func (this *Type) GoString() string
  • func (m *Type) Marshal() (dAtA []byte, err error)
  • func (m *Type) MarshalTo(dAtA []byte) (int, error)
  • func (*Type) ProtoMessage()
  • func (m *Type) Reset()
  • func (m *Type) Size() (n int)
  • func (this *Type) String() string
  • func (m *Type) Unmarshal(dAtA []byte) error

Constants

const TemplateName = "logentry"

Fully qualified name of the template

Variables

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

Types

type Handler

type Handler interface {
	adapter.Handler

	// HandleLogEntry is called by Mixer at request time to deliver instances to
	// to an adapter.
	HandleLogEntry(context.Context, []*Instance) error
}

Handler must be implemented by adapter code if it wants to process data associated with the 'logentry' template.

Mixer uses this interface to call into the adapter at request time in order to dispatch created instances to the adapter. Adapters take the incoming instances and do what they need to achieve their primary function.

The name of each instance can be used as a key into the Type map supplied to the adapter at configuration time via the method 'SetLogEntryTypes'. These Type associated with an instance describes the shape of the instance

type HandlerBuilder

type HandlerBuilder interface {
	adapter.HandlerBuilder

	// SetLogEntryTypes is invoked by Mixer to pass the template-specific Type information for instances that an adapter
	// may receive at runtime. The type information describes the shape of the instance.
	SetLogEntryTypes(map[string]*Type)
}

HandlerBuilder must be implemented by adapters if they want to process data associated with the 'logentry' template.

Mixer uses this interface to call into the adapter at configuration time to configure it with adapter-specific configuration as well as all template-specific type information.

type Instance

type Instance struct {
	// Name of the instance as specified in configuration.
	Name string

	// Variables that are delivered for each log entry.
	Variables map[string]interface{}

	// Timestamp is the time value for the log entry
	Timestamp time.Time

	// Severity indicates the importance of the log entry.
	Severity string

	// Optional. An expression to compute the type of the monitored resource this log entry is being recorded on.
	// If the logging backend supports monitored resources, these fields are used to populate that resource.
	// Otherwise these fields will be ignored by the adapter.
	MonitoredResourceType string

	// Optional. A set of expressions that will form the dimensions of the monitored resource this log entry is being
	// recorded on. If the logging backend supports monitored resources, these fields are used to populate that resource.
	// Otherwise these fields will be ignored by the adapter.
	MonitoredResourceDimensions map[string]interface{}
}

Instance is constructed by Mixer for the 'logentry' template.

LogEntry represents an individual entry within a log.

When writing the configuration, the value for the fields associated with this template can either be a literal or an [expression](https://istio.io/docs/reference/config/mixer/expression-language.html). Please note that if the datatype of a field is not istio.mixer.v1.config.descriptor.ValueType, then the expression's [inferred type](https://istio.io/docs/reference/config/mixer/expression-language.html#type-checking) must match the datatype of the field.

Example config: ``` apiVersion: "config.istio.io/v1alpha2" kind: logentry metadata:

name: accesslog
namespace: istio-system

spec:

severity: '"Default"'
timestamp: request.time
variables:
  sourceIp: source.ip | ip("0.0.0.0")
  destinationIp: destination.ip | ip("0.0.0.0")
  sourceUser: source.user | ""
  method: request.method | ""
  url: request.path | ""
  protocol: request.scheme | "http"
  responseCode: response.code | 0
  responseSize: response.size | 0
  requestSize: request.size | 0
  latency: response.duration | "0ms"
monitored_resource_type: '"UNSPECIFIED"'

```

type InstanceParam

type InstanceParam struct {
	Variables                   map[string]string `` /* 152-byte string literal not displayed */
	Timestamp                   string            `protobuf:"bytes,2,opt,name=timestamp,proto3" json:"timestamp,omitempty"`
	Severity                    string            `protobuf:"bytes,3,opt,name=severity,proto3" json:"severity,omitempty"`
	MonitoredResourceType       string            `` /* 126-byte string literal not displayed */
	MonitoredResourceDimensions map[string]string `` /* 225-byte string literal not displayed */
}

func (*InstanceParam) Descriptor

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

func (*InstanceParam) Equal

func (this *InstanceParam) Equal(that interface{}) bool

func (*InstanceParam) GetMonitoredResourceDimensions

func (m *InstanceParam) GetMonitoredResourceDimensions() map[string]string

func (*InstanceParam) GetMonitoredResourceType

func (m *InstanceParam) GetMonitoredResourceType() string

func (*InstanceParam) GetSeverity

func (m *InstanceParam) GetSeverity() string

func (*InstanceParam) GetTimestamp

func (m *InstanceParam) GetTimestamp() string

func (*InstanceParam) GetVariables

func (m *InstanceParam) GetVariables() map[string]string

func (*InstanceParam) GoString

func (this *InstanceParam) GoString() string

func (*InstanceParam) Marshal

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

func (*InstanceParam) MarshalTo

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

func (*InstanceParam) ProtoMessage

func (*InstanceParam) ProtoMessage()

func (*InstanceParam) Reset

func (m *InstanceParam) Reset()

func (*InstanceParam) Size

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

func (*InstanceParam) String

func (this *InstanceParam) String() string

func (*InstanceParam) Unmarshal

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

type Type

type Type struct {
	// Variables that are delivered for each log entry.
	Variables map[string]istio_mixer_v1_config_descriptor.ValueType `` /* 201-byte string literal not displayed */
	// Optional. A set of expressions that will form the dimensions of the monitored resource this log entry is being
	// recorded on. If the logging backend supports monitored resources, these fields are used to populate that resource.
	// Otherwise these fields will be ignored by the adapter.
	MonitoredResourceDimensions map[string]istio_mixer_v1_config_descriptor.ValueType `` /* 274-byte string literal not displayed */
}

LogEntry represents an individual entry within a log.

When writing the configuration, the value for the fields associated with this template can either be a literal or an [expression](https://istio.io/docs/reference/config/mixer/expression-language.html). Please note that if the datatype of a field is not istio.mixer.v1.config.descriptor.ValueType, then the expression's [inferred type](https://istio.io/docs/reference/config/mixer/expression-language.html#type-checking) must match the datatype of the field.

Example config: ``` apiVersion: "config.istio.io/v1alpha2" kind: logentry metadata:

name: accesslog
namespace: istio-system

spec:

severity: '"Default"'
timestamp: request.time
variables:
  sourceIp: source.ip | ip("0.0.0.0")
  destinationIp: destination.ip | ip("0.0.0.0")
  sourceUser: source.user | ""
  method: request.method | ""
  url: request.path | ""
  protocol: request.scheme | "http"
  responseCode: response.code | 0
  responseSize: response.size | 0
  requestSize: request.size | 0
  latency: response.duration | "0ms"
monitored_resource_type: '"UNSPECIFIED"'

```

func (*Type) Descriptor

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

func (*Type) Equal

func (this *Type) Equal(that interface{}) bool

func (*Type) GetMonitoredResourceDimensions

func (m *Type) GetMonitoredResourceDimensions() map[string]istio_mixer_v1_config_descriptor.ValueType

func (*Type) GetVariables

func (m *Type) GetVariables() map[string]istio_mixer_v1_config_descriptor.ValueType

func (*Type) GoString

func (this *Type) GoString() string

func (*Type) Marshal

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

func (*Type) MarshalTo

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

func (*Type) ProtoMessage

func (*Type) ProtoMessage()

func (*Type) Reset

func (m *Type) Reset()

func (*Type) Size

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

func (*Type) String

func (this *Type) String() string

func (*Type) Unmarshal

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