go-control-plane: github.com/envoyproxy/go-control-plane/envoy/config/accesslog/v2 Index | Files

package envoy_config_accesslog_v2

import "github.com/envoyproxy/go-control-plane/envoy/config/accesslog/v2"

Index

Package Files

als.pb.go als.pb.validate.go file.pb.go file.pb.validate.go

Variables

var File_envoy_config_accesslog_v2_als_proto protoreflect.FileDescriptor
var File_envoy_config_accesslog_v2_file_proto protoreflect.FileDescriptor

type CommonGrpcAccessLogConfig Uses

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 Uses

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

Deprecated: Use CommonGrpcAccessLogConfig.ProtoReflect.Descriptor instead.

func (*CommonGrpcAccessLogConfig) GetBufferFlushInterval Uses

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

func (*CommonGrpcAccessLogConfig) GetBufferSizeBytes Uses

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

func (*CommonGrpcAccessLogConfig) GetFilterStateObjectsToLog Uses

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

func (*CommonGrpcAccessLogConfig) GetGrpcService Uses

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

func (*CommonGrpcAccessLogConfig) GetLogName Uses

func (x *CommonGrpcAccessLogConfig) GetLogName() string

func (*CommonGrpcAccessLogConfig) ProtoMessage Uses

func (*CommonGrpcAccessLogConfig) ProtoMessage()

func (*CommonGrpcAccessLogConfig) ProtoReflect Uses

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

func (*CommonGrpcAccessLogConfig) Reset Uses

func (x *CommonGrpcAccessLogConfig) Reset()

func (*CommonGrpcAccessLogConfig) String Uses

func (x *CommonGrpcAccessLogConfig) String() string

func (*CommonGrpcAccessLogConfig) Validate Uses

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 Uses

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 Uses

func (e CommonGrpcAccessLogConfigValidationError) Cause() error

Cause function returns cause value.

func (CommonGrpcAccessLogConfigValidationError) Error Uses

func (e CommonGrpcAccessLogConfigValidationError) Error() string

Error satisfies the builtin error interface

func (CommonGrpcAccessLogConfigValidationError) ErrorName Uses

func (e CommonGrpcAccessLogConfigValidationError) ErrorName() string

ErrorName returns error name.

func (CommonGrpcAccessLogConfigValidationError) Field Uses

func (e CommonGrpcAccessLogConfigValidationError) Field() string

Field function returns field value.

func (CommonGrpcAccessLogConfigValidationError) Key Uses

func (e CommonGrpcAccessLogConfigValidationError) Key() bool

Key function returns key value.

func (CommonGrpcAccessLogConfigValidationError) Reason Uses

func (e CommonGrpcAccessLogConfigValidationError) Reason() string

Reason function returns reason value.

type FileAccessLog Uses

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 Uses

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

Deprecated: Use FileAccessLog.ProtoReflect.Descriptor instead.

func (*FileAccessLog) GetAccessLogFormat Uses

func (m *FileAccessLog) GetAccessLogFormat() isFileAccessLog_AccessLogFormat

func (*FileAccessLog) GetFormat Uses

func (x *FileAccessLog) GetFormat() string

func (*FileAccessLog) GetJsonFormat Uses

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

func (*FileAccessLog) GetPath Uses

func (x *FileAccessLog) GetPath() string

func (*FileAccessLog) GetTypedJsonFormat Uses

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

func (*FileAccessLog) ProtoMessage Uses

func (*FileAccessLog) ProtoMessage()

func (*FileAccessLog) ProtoReflect Uses

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

func (*FileAccessLog) Reset Uses

func (x *FileAccessLog) Reset()

func (*FileAccessLog) String Uses

func (x *FileAccessLog) String() string

func (*FileAccessLog) Validate Uses

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 Uses

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 Uses

func (e FileAccessLogValidationError) Cause() error

Cause function returns cause value.

func (FileAccessLogValidationError) Error Uses

func (e FileAccessLogValidationError) Error() string

Error satisfies the builtin error interface

func (FileAccessLogValidationError) ErrorName Uses

func (e FileAccessLogValidationError) ErrorName() string

ErrorName returns error name.

func (FileAccessLogValidationError) Field Uses

func (e FileAccessLogValidationError) Field() string

Field function returns field value.

func (FileAccessLogValidationError) Key Uses

func (e FileAccessLogValidationError) Key() bool

Key function returns key value.

func (FileAccessLogValidationError) Reason Uses

func (e FileAccessLogValidationError) Reason() string

Reason function returns reason value.

type FileAccessLog_Format Uses

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 Uses

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 Uses

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 Uses

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 Uses

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

Deprecated: Use HttpGrpcAccessLogConfig.ProtoReflect.Descriptor instead.

func (*HttpGrpcAccessLogConfig) GetAdditionalRequestHeadersToLog Uses

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

func (*HttpGrpcAccessLogConfig) GetAdditionalResponseHeadersToLog Uses

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

func (*HttpGrpcAccessLogConfig) GetAdditionalResponseTrailersToLog Uses

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

func (*HttpGrpcAccessLogConfig) GetCommonConfig Uses

func (x *HttpGrpcAccessLogConfig) GetCommonConfig() *CommonGrpcAccessLogConfig

func (*HttpGrpcAccessLogConfig) ProtoMessage Uses

func (*HttpGrpcAccessLogConfig) ProtoMessage()

func (*HttpGrpcAccessLogConfig) ProtoReflect Uses

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

func (*HttpGrpcAccessLogConfig) Reset Uses

func (x *HttpGrpcAccessLogConfig) Reset()

func (*HttpGrpcAccessLogConfig) String Uses

func (x *HttpGrpcAccessLogConfig) String() string

func (*HttpGrpcAccessLogConfig) Validate Uses

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 Uses

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 Uses

func (e HttpGrpcAccessLogConfigValidationError) Cause() error

Cause function returns cause value.

func (HttpGrpcAccessLogConfigValidationError) Error Uses

func (e HttpGrpcAccessLogConfigValidationError) Error() string

Error satisfies the builtin error interface

func (HttpGrpcAccessLogConfigValidationError) ErrorName Uses

func (e HttpGrpcAccessLogConfigValidationError) ErrorName() string

ErrorName returns error name.

func (HttpGrpcAccessLogConfigValidationError) Field Uses

func (e HttpGrpcAccessLogConfigValidationError) Field() string

Field function returns field value.

func (HttpGrpcAccessLogConfigValidationError) Key Uses

func (e HttpGrpcAccessLogConfigValidationError) Key() bool

Key function returns key value.

func (HttpGrpcAccessLogConfigValidationError) Reason Uses

func (e HttpGrpcAccessLogConfigValidationError) Reason() string

Reason function returns reason value.

type TcpGrpcAccessLogConfig Uses

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 Uses

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

Deprecated: Use TcpGrpcAccessLogConfig.ProtoReflect.Descriptor instead.

func (*TcpGrpcAccessLogConfig) GetCommonConfig Uses

func (x *TcpGrpcAccessLogConfig) GetCommonConfig() *CommonGrpcAccessLogConfig

func (*TcpGrpcAccessLogConfig) ProtoMessage Uses

func (*TcpGrpcAccessLogConfig) ProtoMessage()

func (*TcpGrpcAccessLogConfig) ProtoReflect Uses

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

func (*TcpGrpcAccessLogConfig) Reset Uses

func (x *TcpGrpcAccessLogConfig) Reset()

func (*TcpGrpcAccessLogConfig) String Uses

func (x *TcpGrpcAccessLogConfig) String() string

func (*TcpGrpcAccessLogConfig) Validate Uses

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 Uses

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 Uses

func (e TcpGrpcAccessLogConfigValidationError) Cause() error

Cause function returns cause value.

func (TcpGrpcAccessLogConfigValidationError) Error Uses

func (e TcpGrpcAccessLogConfigValidationError) Error() string

Error satisfies the builtin error interface

func (TcpGrpcAccessLogConfigValidationError) ErrorName Uses

func (e TcpGrpcAccessLogConfigValidationError) ErrorName() string

ErrorName returns error name.

func (TcpGrpcAccessLogConfigValidationError) Field Uses

func (e TcpGrpcAccessLogConfigValidationError) Field() string

Field function returns field value.

func (TcpGrpcAccessLogConfigValidationError) Key Uses

func (e TcpGrpcAccessLogConfigValidationError) Key() bool

Key function returns key value.

func (TcpGrpcAccessLogConfigValidationError) Reason Uses

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.