open_telemetryv3

Documentation

Index

• Variables
• type OpenTelemetryAccessLogConfig
  • func (*OpenTelemetryAccessLogConfig) Descriptor() ([]byte, []int)
  • func (x *OpenTelemetryAccessLogConfig) GetAttributes() *v1.KeyValueList
  • func (x *OpenTelemetryAccessLogConfig) GetBody() *v1.AnyValue
  • func (x *OpenTelemetryAccessLogConfig) GetCommonConfig() *v3.CommonGrpcAccessLogConfig
  • func (x *OpenTelemetryAccessLogConfig) GetDisableBuiltinLabels() bool
  • func (x *OpenTelemetryAccessLogConfig) GetFormatters() []*v31.TypedExtensionConfig
  • func (x *OpenTelemetryAccessLogConfig) GetResourceAttributes() *v1.KeyValueList
  • func (x *OpenTelemetryAccessLogConfig) GetStatPrefix() string
  • func (*OpenTelemetryAccessLogConfig) ProtoMessage()
  • func (x *OpenTelemetryAccessLogConfig) ProtoReflect() protoreflect.Message
  • func (x *OpenTelemetryAccessLogConfig) Reset()
  • func (x *OpenTelemetryAccessLogConfig) String() string
  • func (m *OpenTelemetryAccessLogConfig) Validate() error
  • func (m *OpenTelemetryAccessLogConfig) ValidateAll() error
• type OpenTelemetryAccessLogConfigMultiError
  • func (m OpenTelemetryAccessLogConfigMultiError) AllErrors() []error
  • func (m OpenTelemetryAccessLogConfigMultiError) Error() string
• type OpenTelemetryAccessLogConfigValidationError
  • func (e OpenTelemetryAccessLogConfigValidationError) Cause() error
  • func (e OpenTelemetryAccessLogConfigValidationError) Error() string
  • func (e OpenTelemetryAccessLogConfigValidationError) ErrorName() string
  • func (e OpenTelemetryAccessLogConfigValidationError) Field() string
  • func (e OpenTelemetryAccessLogConfigValidationError) Key() bool
  • func (e OpenTelemetryAccessLogConfigValidationError) Reason() string

Variables

var File_envoy_extensions_access_loggers_open_telemetry_v3_logs_service_proto protoreflect.FileDescriptor

Types

type OpenTelemetryAccessLogConfig

type OpenTelemetryAccessLogConfig struct {

	// [#comment:TODO(itamarkam): add 'filter_state_objects_to_log' to logs.]
	CommonConfig *v3.CommonGrpcAccessLogConfig `protobuf:"bytes,1,opt,name=common_config,json=commonConfig,proto3" json:"common_config,omitempty"`
	// If specified, Envoy will not generate built-in resource labels
	// like “log_name“, “zone_name“, “cluster_name“, “node_name“.
	DisableBuiltinLabels bool `protobuf:"varint,5,opt,name=disable_builtin_labels,json=disableBuiltinLabels,proto3" json:"disable_builtin_labels,omitempty"`
	// OpenTelemetry `Resource <https://github.com/open-telemetry/opentelemetry-proto/blob/main/opentelemetry/proto/logs/v1/logs.proto#L51>`_
	// attributes are filled with Envoy node info.
	// Example: “resource_attributes { values { key: "region" value { string_value: "cn-north-7" } } }“.
	ResourceAttributes *v1.KeyValueList `protobuf:"bytes,4,opt,name=resource_attributes,json=resourceAttributes,proto3" json:"resource_attributes,omitempty"`
	// OpenTelemetry `LogResource <https://github.com/open-telemetry/opentelemetry-proto/blob/main/opentelemetry/proto/logs/v1/logs.proto>`_
	// fields, following `Envoy access logging formatting <https://www.envoyproxy.io/docs/envoy/latest/configuration/observability/access_log/usage>`_.
	//
	// See 'body' in the LogResource proto for more details.
	// Example: “body { string_value: "%PROTOCOL%" }“.
	Body *v1.AnyValue `protobuf:"bytes,2,opt,name=body,proto3" json:"body,omitempty"`
	// See 'attributes' in the LogResource proto for more details.
	// Example: “attributes { values { key: "user_agent" value { string_value: "%REQ(USER-AGENT)%" } } }“.
	Attributes *v1.KeyValueList `protobuf:"bytes,3,opt,name=attributes,proto3" json:"attributes,omitempty"`
	// Optional. Additional prefix to use on OpenTelemetry access logger stats. If empty, the stats will be rooted at
	// “access_logs.open_telemetry_access_log.“. If non-empty, stats will be rooted at
	// “access_logs.open_telemetry_access_log.<stat_prefix>.“.
	StatPrefix string `protobuf:"bytes,6,opt,name=stat_prefix,json=statPrefix,proto3" json:"stat_prefix,omitempty"`
	// Specifies a collection of Formatter plugins that can be called from the access log configuration.
	// See the formatters extensions documentation for details.
	// [#extension-category: envoy.formatter]
	Formatters []*v31.TypedExtensionConfig `protobuf:"bytes,7,rep,name=formatters,proto3" json:"formatters,omitempty"`
	// contains filtered or unexported fields
}

Configuration for the built-in “envoy.access_loggers.open_telemetry“ :ref:`AccessLog <envoy_v3_api_msg_config.accesslog.v3.AccessLog>`. This configuration will populate `opentelemetry.proto.collector.v1.logs.ExportLogsServiceRequest.resource_logs <https://github.com/open-telemetry/opentelemetry-proto/blob/main/opentelemetry/proto/collector/logs/v1/logs_service.proto>`_. In addition, the request start time is set in the dedicated field. [#extension: envoy.access_loggers.open_telemetry] [#next-free-field: 8]

func (*OpenTelemetryAccessLogConfig) Descriptor

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

Deprecated: Use OpenTelemetryAccessLogConfig.ProtoReflect.Descriptor instead.

func (*OpenTelemetryAccessLogConfig) GetAttributes

func (x *OpenTelemetryAccessLogConfig) GetAttributes() *v1.KeyValueList

func (*OpenTelemetryAccessLogConfig) GetBody

func (x *OpenTelemetryAccessLogConfig) GetBody() *v1.AnyValue

func (*OpenTelemetryAccessLogConfig) GetCommonConfig

func (x *OpenTelemetryAccessLogConfig) GetCommonConfig() *v3.CommonGrpcAccessLogConfig

func (*OpenTelemetryAccessLogConfig) GetDisableBuiltinLabels

func (x *OpenTelemetryAccessLogConfig) GetDisableBuiltinLabels() bool

func (*OpenTelemetryAccessLogConfig) GetFormatters

func (x *OpenTelemetryAccessLogConfig) GetFormatters() []*v31.TypedExtensionConfig

func (*OpenTelemetryAccessLogConfig) GetResourceAttributes

func (x *OpenTelemetryAccessLogConfig) GetResourceAttributes() *v1.KeyValueList

func (*OpenTelemetryAccessLogConfig) GetStatPrefix

func (x *OpenTelemetryAccessLogConfig) GetStatPrefix() string

func (*OpenTelemetryAccessLogConfig) ProtoMessage

func (*OpenTelemetryAccessLogConfig) ProtoMessage()

func (*OpenTelemetryAccessLogConfig) ProtoReflect

func (x *OpenTelemetryAccessLogConfig) ProtoReflect() protoreflect.Message

func (*OpenTelemetryAccessLogConfig) Reset

func (x *OpenTelemetryAccessLogConfig) Reset()

func (*OpenTelemetryAccessLogConfig) String

func (x *OpenTelemetryAccessLogConfig) String() string

func (*OpenTelemetryAccessLogConfig) Validate

func (m *OpenTelemetryAccessLogConfig) Validate() error

Validate checks the field values on OpenTelemetryAccessLogConfig with the rules defined in the proto definition for this message. If any rules are violated, the first error encountered is returned, or nil if there are no violations.

func (*OpenTelemetryAccessLogConfig) ValidateAll

func (m *OpenTelemetryAccessLogConfig) ValidateAll() error

ValidateAll checks the field values on OpenTelemetryAccessLogConfig with the rules defined in the proto definition for this message. If any rules are violated, the result is a list of violation errors wrapped in OpenTelemetryAccessLogConfigMultiError, or nil if none found.

type OpenTelemetryAccessLogConfigMultiError

type OpenTelemetryAccessLogConfigMultiError []error

OpenTelemetryAccessLogConfigMultiError is an error wrapping multiple validation errors returned by OpenTelemetryAccessLogConfig.ValidateAll() if the designated constraints aren't met.

func (OpenTelemetryAccessLogConfigMultiError) AllErrors

func (m OpenTelemetryAccessLogConfigMultiError) AllErrors() []error

AllErrors returns a list of validation violation errors.

func (OpenTelemetryAccessLogConfigMultiError) Error

func (m OpenTelemetryAccessLogConfigMultiError) Error() string

Error returns a concatenation of all the error messages it wraps.

type OpenTelemetryAccessLogConfigValidationError

type OpenTelemetryAccessLogConfigValidationError struct {
	// contains filtered or unexported fields
}

OpenTelemetryAccessLogConfigValidationError is the validation error returned by OpenTelemetryAccessLogConfig.Validate if the designated constraints aren't met.

func (OpenTelemetryAccessLogConfigValidationError) Cause

func (e OpenTelemetryAccessLogConfigValidationError) Cause() error

Cause function returns cause value.

func (OpenTelemetryAccessLogConfigValidationError) Error

func (e OpenTelemetryAccessLogConfigValidationError) Error() string

Error satisfies the builtin error interface

func (OpenTelemetryAccessLogConfigValidationError) ErrorName

func (e OpenTelemetryAccessLogConfigValidationError) ErrorName() string

ErrorName returns error name.

func (OpenTelemetryAccessLogConfigValidationError) Field

func (e OpenTelemetryAccessLogConfigValidationError) Field() string

Field function returns field value.

func (OpenTelemetryAccessLogConfigValidationError) Key

func (e OpenTelemetryAccessLogConfigValidationError) Key() bool

Key function returns key value.

func (OpenTelemetryAccessLogConfigValidationError) Reason

func (e OpenTelemetryAccessLogConfigValidationError) Reason() string

Reason function returns reason value.