Documentation ¶
Index ¶
- Variables
- type CommonGrpcAccessLogConfig
- func (*CommonGrpcAccessLogConfig) Descriptor() ([]byte, []int)deprecated
- 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
- type CommonGrpcAccessLogConfigValidationError
- func (e CommonGrpcAccessLogConfigValidationError) Cause() error
- func (e CommonGrpcAccessLogConfigValidationError) Error() string
- func (e CommonGrpcAccessLogConfigValidationError) ErrorName() string
- func (e CommonGrpcAccessLogConfigValidationError) Field() string
- func (e CommonGrpcAccessLogConfigValidationError) Key() bool
- func (e CommonGrpcAccessLogConfigValidationError) Reason() string
- type FileAccessLog
- func (*FileAccessLog) Descriptor() ([]byte, []int)deprecated
- 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
- type FileAccessLogValidationError
- func (e FileAccessLogValidationError) Cause() error
- func (e FileAccessLogValidationError) Error() string
- func (e FileAccessLogValidationError) ErrorName() string
- func (e FileAccessLogValidationError) Field() string
- func (e FileAccessLogValidationError) Key() bool
- func (e FileAccessLogValidationError) Reason() string
- type FileAccessLog_Format
- type FileAccessLog_JsonFormat
- type FileAccessLog_TypedJsonFormat
- type HttpGrpcAccessLogConfig
- func (*HttpGrpcAccessLogConfig) Descriptor() ([]byte, []int)deprecated
- 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
- type HttpGrpcAccessLogConfigValidationError
- func (e HttpGrpcAccessLogConfigValidationError) Cause() error
- func (e HttpGrpcAccessLogConfigValidationError) Error() string
- func (e HttpGrpcAccessLogConfigValidationError) ErrorName() string
- func (e HttpGrpcAccessLogConfigValidationError) Field() string
- func (e HttpGrpcAccessLogConfigValidationError) Key() bool
- func (e HttpGrpcAccessLogConfigValidationError) Reason() string
- type TcpGrpcAccessLogConfig
- func (*TcpGrpcAccessLogConfig) Descriptor() ([]byte, []int)deprecated
- 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
- type TcpGrpcAccessLogConfigValidationError
- func (e TcpGrpcAccessLogConfigValidationError) Cause() error
- func (e TcpGrpcAccessLogConfigValidationError) Error() string
- func (e TcpGrpcAccessLogConfigValidationError) ErrorName() string
- func (e TcpGrpcAccessLogConfigValidationError) Field() string
- func (e TcpGrpcAccessLogConfigValidationError) Key() bool
- func (e TcpGrpcAccessLogConfigValidationError) Reason() string
Constants ¶
This section is empty.
Variables ¶
var File_envoy_config_accesslog_v2_als_proto protoreflect.FileDescriptor
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 *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 `` /* 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 ¶ added in v0.9.82
func (x *CommonGrpcAccessLogConfig) GetBufferFlushInterval() *duration.Duration
func (*CommonGrpcAccessLogConfig) GetBufferSizeBytes ¶ added in v0.9.82
func (x *CommonGrpcAccessLogConfig) GetBufferSizeBytes() *wrappers.UInt32Value
func (*CommonGrpcAccessLogConfig) GetFilterStateObjectsToLog ¶ added in v0.9.82
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 ¶ added in v0.9.82
func (x *CommonGrpcAccessLogConfig) ProtoReflect() protoreflect.Message
func (*CommonGrpcAccessLogConfig) Reset ¶
func (x *CommonGrpcAccessLogConfig) Reset()
func (*CommonGrpcAccessLogConfig) String ¶
func (x *CommonGrpcAccessLogConfig) String() string
func (*CommonGrpcAccessLogConfig) Validate ¶
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 ¶
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 (CommonGrpcAccessLogConfigValidationError) Cause ¶
func (e CommonGrpcAccessLogConfigValidationError) Cause() error
Cause function returns cause value.
func (CommonGrpcAccessLogConfigValidationError) Error ¶
func (e CommonGrpcAccessLogConfigValidationError) Error() string
Error satisfies the builtin error interface
func (CommonGrpcAccessLogConfigValidationError) ErrorName ¶ added in v0.7.0
func (e CommonGrpcAccessLogConfigValidationError) ErrorName() string
ErrorName returns error name.
func (CommonGrpcAccessLogConfigValidationError) Field ¶
func (e CommonGrpcAccessLogConfigValidationError) Field() string
Field function returns field value.
func (CommonGrpcAccessLogConfigValidationError) Key ¶
func (e CommonGrpcAccessLogConfigValidationError) Key() bool
Key function returns key value.
func (CommonGrpcAccessLogConfigValidationError) Reason ¶
func (e CommonGrpcAccessLogConfigValidationError) Reason() string
Reason function returns reason value.
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 ¶ added in v0.6.2
func (m *FileAccessLog) GetAccessLogFormat() isFileAccessLog_AccessLogFormat
func (*FileAccessLog) GetFormat ¶
func (x *FileAccessLog) GetFormat() string
func (*FileAccessLog) GetJsonFormat ¶ added in v0.6.2
func (x *FileAccessLog) GetJsonFormat() *_struct.Struct
func (*FileAccessLog) GetPath ¶
func (x *FileAccessLog) GetPath() string
func (*FileAccessLog) GetTypedJsonFormat ¶ added in v0.9.82
func (x *FileAccessLog) GetTypedJsonFormat() *_struct.Struct
func (*FileAccessLog) ProtoMessage ¶
func (*FileAccessLog) ProtoMessage()
func (*FileAccessLog) ProtoReflect ¶ added in v0.9.82
func (x *FileAccessLog) ProtoReflect() protoreflect.Message
func (*FileAccessLog) Reset ¶
func (x *FileAccessLog) Reset()
func (*FileAccessLog) String ¶
func (x *FileAccessLog) String() string
func (*FileAccessLog) Validate ¶
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 ¶
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 (FileAccessLogValidationError) Cause ¶
func (e FileAccessLogValidationError) Cause() error
Cause function returns cause value.
func (FileAccessLogValidationError) Error ¶
func (e FileAccessLogValidationError) Error() string
Error satisfies the builtin error interface
func (FileAccessLogValidationError) ErrorName ¶ added in v0.7.0
func (e FileAccessLogValidationError) ErrorName() string
ErrorName returns error name.
func (FileAccessLogValidationError) Field ¶
func (e FileAccessLogValidationError) Field() string
Field function returns field value.
func (FileAccessLogValidationError) Key ¶
func (e FileAccessLogValidationError) Key() bool
Key function returns key value.
func (FileAccessLogValidationError) Reason ¶
func (e FileAccessLogValidationError) Reason() string
Reason function returns reason value.
type FileAccessLog_Format ¶ added in v0.6.2
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 ¶ added in v0.6.2
type FileAccessLog_TypedJsonFormat ¶ added in v0.9.82
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 ¶
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 ¶ added in v0.9.82
func (x *HttpGrpcAccessLogConfig) ProtoReflect() protoreflect.Message
func (*HttpGrpcAccessLogConfig) Reset ¶
func (x *HttpGrpcAccessLogConfig) Reset()
func (*HttpGrpcAccessLogConfig) String ¶
func (x *HttpGrpcAccessLogConfig) String() string
func (*HttpGrpcAccessLogConfig) Validate ¶
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 ¶
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 (HttpGrpcAccessLogConfigValidationError) Cause ¶
func (e HttpGrpcAccessLogConfigValidationError) Cause() error
Cause function returns cause value.
func (HttpGrpcAccessLogConfigValidationError) Error ¶
func (e HttpGrpcAccessLogConfigValidationError) Error() string
Error satisfies the builtin error interface
func (HttpGrpcAccessLogConfigValidationError) ErrorName ¶ added in v0.7.0
func (e HttpGrpcAccessLogConfigValidationError) ErrorName() string
ErrorName returns error name.
func (HttpGrpcAccessLogConfigValidationError) Field ¶
func (e HttpGrpcAccessLogConfigValidationError) Field() string
Field function returns field value.
func (HttpGrpcAccessLogConfigValidationError) Key ¶
func (e HttpGrpcAccessLogConfigValidationError) Key() bool
Key function returns key value.
func (HttpGrpcAccessLogConfigValidationError) Reason ¶
func (e HttpGrpcAccessLogConfigValidationError) Reason() string
Reason function returns reason value.
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 ¶ added in v0.9.82
func (x *TcpGrpcAccessLogConfig) ProtoReflect() protoreflect.Message
func (*TcpGrpcAccessLogConfig) Reset ¶
func (x *TcpGrpcAccessLogConfig) Reset()
func (*TcpGrpcAccessLogConfig) String ¶
func (x *TcpGrpcAccessLogConfig) String() string
func (*TcpGrpcAccessLogConfig) Validate ¶
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 ¶
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 (TcpGrpcAccessLogConfigValidationError) Cause ¶
func (e TcpGrpcAccessLogConfigValidationError) Cause() error
Cause function returns cause value.
func (TcpGrpcAccessLogConfigValidationError) Error ¶
func (e TcpGrpcAccessLogConfigValidationError) Error() string
Error satisfies the builtin error interface
func (TcpGrpcAccessLogConfigValidationError) ErrorName ¶ added in v0.7.0
func (e TcpGrpcAccessLogConfigValidationError) ErrorName() string
ErrorName returns error name.
func (TcpGrpcAccessLogConfigValidationError) Field ¶
func (e TcpGrpcAccessLogConfigValidationError) Field() string
Field function returns field value.
func (TcpGrpcAccessLogConfigValidationError) Key ¶
func (e TcpGrpcAccessLogConfigValidationError) Key() bool
Key function returns key value.
func (TcpGrpcAccessLogConfigValidationError) Reason ¶
func (e TcpGrpcAccessLogConfigValidationError) Reason() string
Reason function returns reason value.