accesslogv2

package
v0.0.2 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Aug 8, 2024 License: Apache-2.0 Imports: 10 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

View Source
var File_envoy_config_accesslog_v2_als_proto protoreflect.FileDescriptor
View Source
var File_envoy_config_accesslog_v2_file_proto protoreflect.FileDescriptor

Functions

This section is empty.

Types

type CommonGrpcAccessLogConfig

type CommonGrpcAccessLogConfig struct {

	// The friendly name of the access log to be returned in :ref:`StreamAccessLogsMessage.Identifier
	// <envoy_api_msg_service.accesslog.v2.StreamAccessLogsMessage.Identifier>`. This allows the
	// access log server to differentiate between different access logs coming from the same Envoy.
	LogName string `protobuf:"bytes,1,opt,name=log_name,json=logName,proto3" json:"log_name,omitempty"`
	// The gRPC service for the access log service.
	GrpcService *core.GrpcService `protobuf:"bytes,2,opt,name=grpc_service,json=grpcService,proto3" json:"grpc_service,omitempty"`
	// Interval for flushing access logs to the gRPC stream. Logger will flush requests every time
	// this interval is elapsed, or when batch size limit is hit, whichever comes first. Defaults to
	// 1 second.
	BufferFlushInterval *durationpb.Duration `protobuf:"bytes,3,opt,name=buffer_flush_interval,json=bufferFlushInterval,proto3" json:"buffer_flush_interval,omitempty"`
	// Soft size limit in bytes for access log entries buffer. Logger will buffer requests until
	// this limit it hit, or every time flush interval is elapsed, whichever comes first. Setting it
	// to zero effectively disables the batching. Defaults to 16384.
	BufferSizeBytes *wrapperspb.UInt32Value `protobuf:"bytes,4,opt,name=buffer_size_bytes,json=bufferSizeBytes,proto3" json:"buffer_size_bytes,omitempty"`
	// Additional filter state objects to log in :ref:`filter_state_objects
	// <envoy_api_field_data.accesslog.v2.AccessLogCommon.filter_state_objects>`.
	// Logger will call `FilterState::Object::serializeAsProto` to serialize the filter state object.
	FilterStateObjectsToLog []string `` /* 136-byte string literal not displayed */
	// contains filtered or unexported fields
}

Common configuration for gRPC access logs. [#next-free-field: 6]

func (*CommonGrpcAccessLogConfig) Descriptor deprecated

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

Deprecated: Use CommonGrpcAccessLogConfig.ProtoReflect.Descriptor instead.

func (*CommonGrpcAccessLogConfig) GetBufferFlushInterval

func (x *CommonGrpcAccessLogConfig) GetBufferFlushInterval() *durationpb.Duration

func (*CommonGrpcAccessLogConfig) GetBufferSizeBytes

func (x *CommonGrpcAccessLogConfig) GetBufferSizeBytes() *wrapperspb.UInt32Value

func (*CommonGrpcAccessLogConfig) GetFilterStateObjectsToLog

func (x *CommonGrpcAccessLogConfig) GetFilterStateObjectsToLog() []string

func (*CommonGrpcAccessLogConfig) GetGrpcService

func (x *CommonGrpcAccessLogConfig) GetGrpcService() *core.GrpcService

func (*CommonGrpcAccessLogConfig) GetLogName

func (x *CommonGrpcAccessLogConfig) GetLogName() string

func (*CommonGrpcAccessLogConfig) ProtoMessage

func (*CommonGrpcAccessLogConfig) ProtoMessage()

func (*CommonGrpcAccessLogConfig) ProtoReflect

func (*CommonGrpcAccessLogConfig) Reset

func (x *CommonGrpcAccessLogConfig) Reset()

func (*CommonGrpcAccessLogConfig) String

func (x *CommonGrpcAccessLogConfig) String() string

type FileAccessLog

type FileAccessLog struct {

	// A path to a local file to which to write the access log entries.
	Path string `protobuf:"bytes,1,opt,name=path,proto3" json:"path,omitempty"`
	// Types that are assignable to AccessLogFormat:
	//
	//	*FileAccessLog_Format
	//	*FileAccessLog_JsonFormat
	//	*FileAccessLog_TypedJsonFormat
	AccessLogFormat isFileAccessLog_AccessLogFormat `protobuf_oneof:"access_log_format"`
	// contains filtered or unexported fields
}

Custom configuration for an :ref:`AccessLog <envoy_api_msg_config.filter.accesslog.v2.AccessLog>` that writes log entries directly to a file. Configures the built-in *envoy.access_loggers.file* AccessLog.

func (*FileAccessLog) Descriptor deprecated

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

Deprecated: Use FileAccessLog.ProtoReflect.Descriptor instead.

func (*FileAccessLog) GetAccessLogFormat

func (m *FileAccessLog) GetAccessLogFormat() isFileAccessLog_AccessLogFormat

func (*FileAccessLog) GetFormat

func (x *FileAccessLog) GetFormat() string

func (*FileAccessLog) GetJsonFormat

func (x *FileAccessLog) GetJsonFormat() *structpb.Struct

func (*FileAccessLog) GetPath

func (x *FileAccessLog) GetPath() string

func (*FileAccessLog) GetTypedJsonFormat

func (x *FileAccessLog) GetTypedJsonFormat() *structpb.Struct

func (*FileAccessLog) ProtoMessage

func (*FileAccessLog) ProtoMessage()

func (*FileAccessLog) ProtoReflect

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

func (*FileAccessLog) Reset

func (x *FileAccessLog) Reset()

func (*FileAccessLog) String

func (x *FileAccessLog) String() string

type FileAccessLog_Format

type FileAccessLog_Format struct {
	// Access log :ref:`format string<config_access_log_format_strings>`.
	// Envoy supports :ref:`custom access log formats <config_access_log_format>` as well as a
	// :ref:`default format <config_access_log_default_format>`.
	Format string `protobuf:"bytes,2,opt,name=format,proto3,oneof"`
}

type FileAccessLog_JsonFormat

type FileAccessLog_JsonFormat struct {
	// Access log :ref:`format dictionary<config_access_log_format_dictionaries>`. All values
	// are rendered as strings.
	JsonFormat *structpb.Struct `protobuf:"bytes,3,opt,name=json_format,json=jsonFormat,proto3,oneof"`
}

type FileAccessLog_TypedJsonFormat

type FileAccessLog_TypedJsonFormat struct {
	// Access log :ref:`format dictionary<config_access_log_format_dictionaries>`. Values are
	// rendered as strings, numbers, or boolean values as appropriate. Nested JSON objects may
	// be produced by some command operators (e.g.FILTER_STATE or DYNAMIC_METADATA). See the
	// documentation for a specific command operator for details.
	TypedJsonFormat *structpb.Struct `protobuf:"bytes,4,opt,name=typed_json_format,json=typedJsonFormat,proto3,oneof"`
}

type HttpGrpcAccessLogConfig

type HttpGrpcAccessLogConfig struct {
	CommonConfig *CommonGrpcAccessLogConfig `protobuf:"bytes,1,opt,name=common_config,json=commonConfig,proto3" json:"common_config,omitempty"`
	// Additional request headers to log in :ref:`HTTPRequestProperties.request_headers
	// <envoy_api_field_data.accesslog.v2.HTTPRequestProperties.request_headers>`.
	AdditionalRequestHeadersToLog []string `` /* 154-byte string literal not displayed */
	// Additional response headers to log in :ref:`HTTPResponseProperties.response_headers
	// <envoy_api_field_data.accesslog.v2.HTTPResponseProperties.response_headers>`.
	AdditionalResponseHeadersToLog []string `` /* 157-byte string literal not displayed */
	// Additional response trailers to log in :ref:`HTTPResponseProperties.response_trailers
	// <envoy_api_field_data.accesslog.v2.HTTPResponseProperties.response_trailers>`.
	AdditionalResponseTrailersToLog []string `` /* 160-byte string literal not displayed */
	// contains filtered or unexported fields
}

Configuration for the built-in *envoy.access_loggers.http_grpc* :ref:`AccessLog <envoy_api_msg_config.filter.accesslog.v2.AccessLog>`. This configuration will populate :ref:`StreamAccessLogsMessage.http_logs <envoy_api_field_service.accesslog.v2.StreamAccessLogsMessage.http_logs>`. [#extension: envoy.access_loggers.http_grpc]

func (*HttpGrpcAccessLogConfig) Descriptor deprecated

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

Deprecated: Use HttpGrpcAccessLogConfig.ProtoReflect.Descriptor instead.

func (*HttpGrpcAccessLogConfig) GetAdditionalRequestHeadersToLog

func (x *HttpGrpcAccessLogConfig) GetAdditionalRequestHeadersToLog() []string

func (*HttpGrpcAccessLogConfig) GetAdditionalResponseHeadersToLog

func (x *HttpGrpcAccessLogConfig) GetAdditionalResponseHeadersToLog() []string

func (*HttpGrpcAccessLogConfig) GetAdditionalResponseTrailersToLog

func (x *HttpGrpcAccessLogConfig) GetAdditionalResponseTrailersToLog() []string

func (*HttpGrpcAccessLogConfig) GetCommonConfig

func (x *HttpGrpcAccessLogConfig) GetCommonConfig() *CommonGrpcAccessLogConfig

func (*HttpGrpcAccessLogConfig) ProtoMessage

func (*HttpGrpcAccessLogConfig) ProtoMessage()

func (*HttpGrpcAccessLogConfig) ProtoReflect

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

func (*HttpGrpcAccessLogConfig) Reset

func (x *HttpGrpcAccessLogConfig) Reset()

func (*HttpGrpcAccessLogConfig) String

func (x *HttpGrpcAccessLogConfig) String() string

type TcpGrpcAccessLogConfig

type TcpGrpcAccessLogConfig struct {
	CommonConfig *CommonGrpcAccessLogConfig `protobuf:"bytes,1,opt,name=common_config,json=commonConfig,proto3" json:"common_config,omitempty"`
	// contains filtered or unexported fields
}

Configuration for the built-in *envoy.access_loggers.tcp_grpc* type. This configuration will populate *StreamAccessLogsMessage.tcp_logs*. [#extension: envoy.access_loggers.tcp_grpc]

func (*TcpGrpcAccessLogConfig) Descriptor deprecated

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

Deprecated: Use TcpGrpcAccessLogConfig.ProtoReflect.Descriptor instead.

func (*TcpGrpcAccessLogConfig) GetCommonConfig

func (x *TcpGrpcAccessLogConfig) GetCommonConfig() *CommonGrpcAccessLogConfig

func (*TcpGrpcAccessLogConfig) ProtoMessage

func (*TcpGrpcAccessLogConfig) ProtoMessage()

func (*TcpGrpcAccessLogConfig) ProtoReflect

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

func (*TcpGrpcAccessLogConfig) Reset

func (x *TcpGrpcAccessLogConfig) Reset()

func (*TcpGrpcAccessLogConfig) String

func (x *TcpGrpcAccessLogConfig) String() string

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL