accesslogv2

package
v1.36.3-20240606200854... Latest Latest
Warning

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

 Go to latest Published: unknown License: Apache-2.0 Imports: 9 Imported by: 0

Documentation

Index

Constants

View Source 
const FileAccessLog_AccessLogFormat_not_set_case case_FileAccessLog_AccessLogFormat = 0
View Source 
const FileAccessLog_Format_case case_FileAccessLog_AccessLogFormat = 2
View Source 
const FileAccessLog_JsonFormat_case case_FileAccessLog_AccessLogFormat = 3
View Source 
const FileAccessLog_TypedJsonFormat_case case_FileAccessLog_AccessLogFormat = 4

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) ClearBufferFlushInterval 

func (x *CommonGrpcAccessLogConfig) ClearBufferFlushInterval()

func (*CommonGrpcAccessLogConfig) ClearBufferSizeBytes 

func (x *CommonGrpcAccessLogConfig) ClearBufferSizeBytes()

func (*CommonGrpcAccessLogConfig) ClearGrpcService 

func (x *CommonGrpcAccessLogConfig) ClearGrpcService()

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) HasBufferFlushInterval 

func (x *CommonGrpcAccessLogConfig) HasBufferFlushInterval() bool

func (*CommonGrpcAccessLogConfig) HasBufferSizeBytes 

func (x *CommonGrpcAccessLogConfig) HasBufferSizeBytes() bool

func (*CommonGrpcAccessLogConfig) HasGrpcService 

func (x *CommonGrpcAccessLogConfig) HasGrpcService() bool

func (*CommonGrpcAccessLogConfig) ProtoMessage 

func (*CommonGrpcAccessLogConfig) ProtoMessage()

func (*CommonGrpcAccessLogConfig) ProtoReflect 

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

func (*CommonGrpcAccessLogConfig) Reset 

func (x *CommonGrpcAccessLogConfig) Reset()

func (*CommonGrpcAccessLogConfig) SetBufferFlushInterval 

func (x *CommonGrpcAccessLogConfig) SetBufferFlushInterval(v *durationpb.Duration)

func (*CommonGrpcAccessLogConfig) SetBufferSizeBytes 

func (x *CommonGrpcAccessLogConfig) SetBufferSizeBytes(v *wrapperspb.UInt32Value)

func (*CommonGrpcAccessLogConfig) SetFilterStateObjectsToLog 

func (x *CommonGrpcAccessLogConfig) SetFilterStateObjectsToLog(v []string)

func (*CommonGrpcAccessLogConfig) SetGrpcService 

func (x *CommonGrpcAccessLogConfig) SetGrpcService(v *core.GrpcService)

func (*CommonGrpcAccessLogConfig) SetLogName 

func (x *CommonGrpcAccessLogConfig) SetLogName(v string)

func (*CommonGrpcAccessLogConfig) String 

func (x *CommonGrpcAccessLogConfig) String() string

type CommonGrpcAccessLogConfig_builder 

type CommonGrpcAccessLogConfig_builder 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
	// The gRPC service for the access log service.
	GrpcService *core.GrpcService
	// 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
	// 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
	// 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
	// contains filtered or unexported fields
}

func (CommonGrpcAccessLogConfig_builder) Build 

func (b0 CommonGrpcAccessLogConfig_builder) Build() *CommonGrpcAccessLogConfig

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 valid to be assigned 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) ClearAccessLogFormat 

func (x *FileAccessLog) ClearAccessLogFormat()

func (*FileAccessLog) ClearFormat 

func (x *FileAccessLog) ClearFormat()

func (*FileAccessLog) ClearJsonFormat 

func (x *FileAccessLog) ClearJsonFormat()

func (*FileAccessLog) ClearTypedJsonFormat 

func (x *FileAccessLog) ClearTypedJsonFormat()

func (*FileAccessLog) GetAccessLogFormat 

func (x *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) HasAccessLogFormat 

func (x *FileAccessLog) HasAccessLogFormat() bool

func (*FileAccessLog) HasFormat 

func (x *FileAccessLog) HasFormat() bool

func (*FileAccessLog) HasJsonFormat 

func (x *FileAccessLog) HasJsonFormat() bool

func (*FileAccessLog) HasTypedJsonFormat 

func (x *FileAccessLog) HasTypedJsonFormat() bool

func (*FileAccessLog) ProtoMessage 

func (*FileAccessLog) ProtoMessage()

func (*FileAccessLog) ProtoReflect 

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

func (*FileAccessLog) Reset 

func (x *FileAccessLog) Reset()

func (*FileAccessLog) SetFormat 

func (x *FileAccessLog) SetFormat(v string)

func (*FileAccessLog) SetJsonFormat 

func (x *FileAccessLog) SetJsonFormat(v *structpb.Struct)

func (*FileAccessLog) SetPath 

func (x *FileAccessLog) SetPath(v string)

func (*FileAccessLog) SetTypedJsonFormat 

func (x *FileAccessLog) SetTypedJsonFormat(v *structpb.Struct)

func (*FileAccessLog) String 

func (x *FileAccessLog) String() string

func (*FileAccessLog) WhichAccessLogFormat 

func (x *FileAccessLog) WhichAccessLogFormat() case_FileAccessLog_AccessLogFormat

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 FileAccessLog_builder 

type FileAccessLog_builder struct {

	// A path to a local file to which to write the access log entries.
	Path string
	// Fields of oneof AccessLogFormat:
	// 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
	// Access log :ref:`format dictionary<config_access_log_format_dictionaries>`. All values
	// are rendered as strings.
	JsonFormat *structpb.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
	// contains filtered or unexported fields
}

func (FileAccessLog_builder) Build 

func (b0 FileAccessLog_builder) Build() *FileAccessLog

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) ClearCommonConfig 

func (x *HttpGrpcAccessLogConfig) ClearCommonConfig()

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) HasCommonConfig 

func (x *HttpGrpcAccessLogConfig) HasCommonConfig() bool

func (*HttpGrpcAccessLogConfig) ProtoMessage 

func (*HttpGrpcAccessLogConfig) ProtoMessage()

func (*HttpGrpcAccessLogConfig) ProtoReflect 

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

func (*HttpGrpcAccessLogConfig) Reset 

func (x *HttpGrpcAccessLogConfig) Reset()

func (*HttpGrpcAccessLogConfig) SetAdditionalRequestHeadersToLog 

func (x *HttpGrpcAccessLogConfig) SetAdditionalRequestHeadersToLog(v []string)

func (*HttpGrpcAccessLogConfig) SetAdditionalResponseHeadersToLog 

func (x *HttpGrpcAccessLogConfig) SetAdditionalResponseHeadersToLog(v []string)

func (*HttpGrpcAccessLogConfig) SetAdditionalResponseTrailersToLog 

func (x *HttpGrpcAccessLogConfig) SetAdditionalResponseTrailersToLog(v []string)

func (*HttpGrpcAccessLogConfig) SetCommonConfig 

func (x *HttpGrpcAccessLogConfig) SetCommonConfig(v *CommonGrpcAccessLogConfig)

func (*HttpGrpcAccessLogConfig) String 

func (x *HttpGrpcAccessLogConfig) String() string

type HttpGrpcAccessLogConfig_builder 

type HttpGrpcAccessLogConfig_builder struct {
	CommonConfig *CommonGrpcAccessLogConfig
	// Additional request headers to log in :ref:`HTTPRequestProperties.request_headers
	// <envoy_api_field_data.accesslog.v2.HTTPRequestProperties.request_headers>`.
	AdditionalRequestHeadersToLog []string
	// Additional response headers to log in :ref:`HTTPResponseProperties.response_headers
	// <envoy_api_field_data.accesslog.v2.HTTPResponseProperties.response_headers>`.
	AdditionalResponseHeadersToLog []string
	// Additional response trailers to log in :ref:`HTTPResponseProperties.response_trailers
	// <envoy_api_field_data.accesslog.v2.HTTPResponseProperties.response_trailers>`.
	AdditionalResponseTrailersToLog []string
	// contains filtered or unexported fields
}

func (HttpGrpcAccessLogConfig_builder) Build 

func (b0 HttpGrpcAccessLogConfig_builder) Build() *HttpGrpcAccessLogConfig

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) ClearCommonConfig 

func (x *TcpGrpcAccessLogConfig) ClearCommonConfig()

func (*TcpGrpcAccessLogConfig) GetCommonConfig 

func (x *TcpGrpcAccessLogConfig) GetCommonConfig() *CommonGrpcAccessLogConfig

func (*TcpGrpcAccessLogConfig) HasCommonConfig 

func (x *TcpGrpcAccessLogConfig) HasCommonConfig() bool

func (*TcpGrpcAccessLogConfig) ProtoMessage 

func (*TcpGrpcAccessLogConfig) ProtoMessage()

func (*TcpGrpcAccessLogConfig) ProtoReflect 

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

func (*TcpGrpcAccessLogConfig) Reset 

func (x *TcpGrpcAccessLogConfig) Reset()

func (*TcpGrpcAccessLogConfig) SetCommonConfig 

func (x *TcpGrpcAccessLogConfig) SetCommonConfig(v *CommonGrpcAccessLogConfig)

func (*TcpGrpcAccessLogConfig) String 

func (x *TcpGrpcAccessLogConfig) String() string

type TcpGrpcAccessLogConfig_builder 

type TcpGrpcAccessLogConfig_builder struct {
	CommonConfig *CommonGrpcAccessLogConfig
	// contains filtered or unexported fields
}

func (TcpGrpcAccessLogConfig_builder) Build 

func (b0 TcpGrpcAccessLogConfig_builder) Build() *TcpGrpcAccessLogConfig

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.