import "github.com/envoyproxy/go-control-plane/envoy/config/accesslog/v2"
als.pb.go als.pb.validate.go file.pb.go file.pb.validate.go
var File_envoy_config_accesslog_v2_als_proto protoreflect.FileDescriptor
var File_envoy_config_accesslog_v2_file_proto protoreflect.FileDescriptor
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 *duration.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 *wrappers.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 `protobuf:"bytes,5,rep,name=filter_state_objects_to_log,json=filterStateObjectsToLog,proto3" json:"filter_state_objects_to_log,omitempty"`
// contains filtered or unexported fields
}Common configuration for gRPC access logs. [#next-free-field: 6]
func (*CommonGrpcAccessLogConfig) Descriptor() ([]byte, []int)
Deprecated: Use CommonGrpcAccessLogConfig.ProtoReflect.Descriptor instead.
func (x *CommonGrpcAccessLogConfig) GetBufferFlushInterval() *duration.Duration
func (x *CommonGrpcAccessLogConfig) GetBufferSizeBytes() *wrappers.UInt32Value
func (x *CommonGrpcAccessLogConfig) GetFilterStateObjectsToLog() []string
func (x *CommonGrpcAccessLogConfig) GetGrpcService() *core.GrpcService
func (x *CommonGrpcAccessLogConfig) GetLogName() string
func (*CommonGrpcAccessLogConfig) ProtoMessage()
func (x *CommonGrpcAccessLogConfig) ProtoReflect() protoreflect.Message
func (x *CommonGrpcAccessLogConfig) Reset()
func (x *CommonGrpcAccessLogConfig) String() string
func (m *CommonGrpcAccessLogConfig) Validate() error
Validate checks the field values on CommonGrpcAccessLogConfig with the rules defined in the proto definition for this message. If any rules are violated, an error is returned.
type CommonGrpcAccessLogConfigValidationError struct {
// contains filtered or unexported fields
}CommonGrpcAccessLogConfigValidationError is the validation error returned by CommonGrpcAccessLogConfig.Validate if the designated constraints aren't met.
func (e CommonGrpcAccessLogConfigValidationError) Cause() error
Cause function returns cause value.
func (e CommonGrpcAccessLogConfigValidationError) Error() string
Error satisfies the builtin error interface
func (e CommonGrpcAccessLogConfigValidationError) ErrorName() string
ErrorName returns error name.
func (e CommonGrpcAccessLogConfigValidationError) Field() string
Field function returns field value.
func (e CommonGrpcAccessLogConfigValidationError) Key() bool
Key function returns key value.
func (e CommonGrpcAccessLogConfigValidationError) Reason() string
Reason function returns reason value.
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() ([]byte, []int)
Deprecated: Use FileAccessLog.ProtoReflect.Descriptor instead.
func (m *FileAccessLog) GetAccessLogFormat() isFileAccessLog_AccessLogFormat
func (x *FileAccessLog) GetFormat() string
func (x *FileAccessLog) GetJsonFormat() *_struct.Struct
func (x *FileAccessLog) GetPath() string
func (x *FileAccessLog) GetTypedJsonFormat() *_struct.Struct
func (*FileAccessLog) ProtoMessage()
func (x *FileAccessLog) ProtoReflect() protoreflect.Message
func (x *FileAccessLog) Reset()
func (x *FileAccessLog) String() string
func (m *FileAccessLog) Validate() error
Validate checks the field values on FileAccessLog with the rules defined in the proto definition for this message. If any rules are violated, an error is returned.
type FileAccessLogValidationError struct {
// contains filtered or unexported fields
}FileAccessLogValidationError is the validation error returned by FileAccessLog.Validate if the designated constraints aren't met.
func (e FileAccessLogValidationError) Cause() error
Cause function returns cause value.
func (e FileAccessLogValidationError) Error() string
Error satisfies the builtin error interface
func (e FileAccessLogValidationError) ErrorName() string
ErrorName returns error name.
func (e FileAccessLogValidationError) Field() string
Field function returns field value.
func (e FileAccessLogValidationError) Key() bool
Key function returns key value.
func (e FileAccessLogValidationError) Reason() string
Reason function returns reason value.
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 struct {
// Access log :ref:`format dictionary<config_access_log_format_dictionaries>`. All values
// are rendered as strings.
JsonFormat *_struct.Struct `protobuf:"bytes,3,opt,name=json_format,json=jsonFormat,proto3,oneof"`
}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 *_struct.Struct `protobuf:"bytes,4,opt,name=typed_json_format,json=typedJsonFormat,proto3,oneof"`
}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 `protobuf:"bytes,2,rep,name=additional_request_headers_to_log,json=additionalRequestHeadersToLog,proto3" json:"additional_request_headers_to_log,omitempty"`
// Additional response headers to log in :ref:`HTTPResponseProperties.response_headers
// <envoy_api_field_data.accesslog.v2.HTTPResponseProperties.response_headers>`.
AdditionalResponseHeadersToLog []string `protobuf:"bytes,3,rep,name=additional_response_headers_to_log,json=additionalResponseHeadersToLog,proto3" json:"additional_response_headers_to_log,omitempty"`
// Additional response trailers to log in :ref:`HTTPResponseProperties.response_trailers
// <envoy_api_field_data.accesslog.v2.HTTPResponseProperties.response_trailers>`.
AdditionalResponseTrailersToLog []string `protobuf:"bytes,4,rep,name=additional_response_trailers_to_log,json=additionalResponseTrailersToLog,proto3" json:"additional_response_trailers_to_log,omitempty"`
// 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() ([]byte, []int)
Deprecated: Use HttpGrpcAccessLogConfig.ProtoReflect.Descriptor instead.
func (x *HttpGrpcAccessLogConfig) GetAdditionalRequestHeadersToLog() []string
func (x *HttpGrpcAccessLogConfig) GetAdditionalResponseHeadersToLog() []string
func (x *HttpGrpcAccessLogConfig) GetAdditionalResponseTrailersToLog() []string
func (x *HttpGrpcAccessLogConfig) GetCommonConfig() *CommonGrpcAccessLogConfig
func (*HttpGrpcAccessLogConfig) ProtoMessage()
func (x *HttpGrpcAccessLogConfig) ProtoReflect() protoreflect.Message
func (x *HttpGrpcAccessLogConfig) Reset()
func (x *HttpGrpcAccessLogConfig) String() string
func (m *HttpGrpcAccessLogConfig) Validate() error
Validate checks the field values on HttpGrpcAccessLogConfig with the rules defined in the proto definition for this message. If any rules are violated, an error is returned.
type HttpGrpcAccessLogConfigValidationError struct {
// contains filtered or unexported fields
}HttpGrpcAccessLogConfigValidationError is the validation error returned by HttpGrpcAccessLogConfig.Validate if the designated constraints aren't met.
func (e HttpGrpcAccessLogConfigValidationError) Cause() error
Cause function returns cause value.
func (e HttpGrpcAccessLogConfigValidationError) Error() string
Error satisfies the builtin error interface
func (e HttpGrpcAccessLogConfigValidationError) ErrorName() string
ErrorName returns error name.
func (e HttpGrpcAccessLogConfigValidationError) Field() string
Field function returns field value.
func (e HttpGrpcAccessLogConfigValidationError) Key() bool
Key function returns key value.
func (e HttpGrpcAccessLogConfigValidationError) Reason() string
Reason function returns reason value.
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() ([]byte, []int)
Deprecated: Use TcpGrpcAccessLogConfig.ProtoReflect.Descriptor instead.
func (x *TcpGrpcAccessLogConfig) GetCommonConfig() *CommonGrpcAccessLogConfig
func (*TcpGrpcAccessLogConfig) ProtoMessage()
func (x *TcpGrpcAccessLogConfig) ProtoReflect() protoreflect.Message
func (x *TcpGrpcAccessLogConfig) Reset()
func (x *TcpGrpcAccessLogConfig) String() string
func (m *TcpGrpcAccessLogConfig) Validate() error
Validate checks the field values on TcpGrpcAccessLogConfig with the rules defined in the proto definition for this message. If any rules are violated, an error is returned.
type TcpGrpcAccessLogConfigValidationError struct {
// contains filtered or unexported fields
}TcpGrpcAccessLogConfigValidationError is the validation error returned by TcpGrpcAccessLogConfig.Validate if the designated constraints aren't met.
func (e TcpGrpcAccessLogConfigValidationError) Cause() error
Cause function returns cause value.
func (e TcpGrpcAccessLogConfigValidationError) Error() string
Error satisfies the builtin error interface
func (e TcpGrpcAccessLogConfigValidationError) ErrorName() string
ErrorName returns error name.
func (e TcpGrpcAccessLogConfigValidationError) Field() string
Field function returns field value.
func (e TcpGrpcAccessLogConfigValidationError) Key() bool
Key function returns key value.
func (e TcpGrpcAccessLogConfigValidationError) Reason() string
Reason function returns reason value.
Package envoy_config_accesslog_v2 imports 22 packages (graph) and is imported by 19 packages. Updated 2021-01-08. Refresh now. Tools for package owners.