envoy_extensions_access_loggers_open_telemetry_v3alpha

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 (*OpenTelemetryAccessLogConfig) ProtoMessage()
  • func (x *OpenTelemetryAccessLogConfig) ProtoReflect() protoreflect.Message
  • func (x *OpenTelemetryAccessLogConfig) Reset()
  • func (x *OpenTelemetryAccessLogConfig) String() string
  • func (m *OpenTelemetryAccessLogConfig) Validate() error
• 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_v3alpha_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"`
	// 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"`
	// contains filtered or unexported fields
}

Configuration for the built-in *envoy.access_loggers.open_telemetry* :ref:`AccessLog <envoy_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>`_. OpenTelemetry `Resource <https://github.com/open-telemetry/opentelemetry-proto/blob/main/opentelemetry/proto/resource/v1/resource.proto>`_ attributes are filled with Envoy node info. In addition, the request start time is set in the dedicated field. [#extension: envoy.access_loggers.open_telemetry] [#comment:TODO(itamarkam): allow configuration for resource attributes.]

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) 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, an error is returned.

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.