Documentation
¶
Index ¶
- Variables
- type FluentdAccessLogConfig
- func (*FluentdAccessLogConfig) Descriptor() ([]byte, []int)deprecated
- func (x *FluentdAccessLogConfig) GetBufferFlushInterval() *durationpb.Duration
- func (x *FluentdAccessLogConfig) GetBufferSizeBytes() *wrapperspb.UInt32Value
- func (x *FluentdAccessLogConfig) GetCluster() string
- func (x *FluentdAccessLogConfig) GetFormatters() []*v3.TypedExtensionConfig
- func (x *FluentdAccessLogConfig) GetRecord() *structpb.Struct
- func (x *FluentdAccessLogConfig) GetRetryOptions() *FluentdAccessLogConfig_RetryOptions
- func (x *FluentdAccessLogConfig) GetStatPrefix() string
- func (x *FluentdAccessLogConfig) GetTag() string
- func (*FluentdAccessLogConfig) ProtoMessage()
- func (x *FluentdAccessLogConfig) ProtoReflect() protoreflect.Message
- func (x *FluentdAccessLogConfig) Reset()
- func (x *FluentdAccessLogConfig) String() string
- type FluentdAccessLogConfig_RetryOptions
- func (*FluentdAccessLogConfig_RetryOptions) Descriptor() ([]byte, []int)deprecated
- func (x *FluentdAccessLogConfig_RetryOptions) GetBackoffOptions() *v3.BackoffStrategy
- func (x *FluentdAccessLogConfig_RetryOptions) GetMaxConnectAttempts() *wrapperspb.UInt32Value
- func (*FluentdAccessLogConfig_RetryOptions) ProtoMessage()
- func (x *FluentdAccessLogConfig_RetryOptions) ProtoReflect() protoreflect.Message
- func (x *FluentdAccessLogConfig_RetryOptions) Reset()
- func (x *FluentdAccessLogConfig_RetryOptions) String() string
Constants ¶
This section is empty.
Variables ¶
View Source
var File_envoy_extensions_access_loggers_fluentd_v3_fluentd_proto protoreflect.FileDescriptor
Functions ¶
This section is empty.
Types ¶
type FluentdAccessLogConfig ¶
type FluentdAccessLogConfig struct {
// The upstream cluster to connect to for streaming the Fluentd messages.
Cluster string `protobuf:"bytes,1,opt,name=cluster,proto3" json:"cluster,omitempty"`
// A tag is a string separated with '.' (e.g. log.type) to categorize events.
// See: https://github.com/fluent/fluentd/wiki/Forward-Protocol-Specification-v1#message-modes
Tag string `protobuf:"bytes,2,opt,name=tag,proto3" json:"tag,omitempty"`
// The prefix to use when emitting :ref:`statistics <config_access_log_stats>`.
StatPrefix string `protobuf:"bytes,3,opt,name=stat_prefix,json=statPrefix,proto3" json:"stat_prefix,omitempty"`
// Interval for flushing access logs to the TCP 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,4,opt,name=buffer_flush_interval,json=bufferFlushInterval,proto3" json:"buffer_flush_interval,omitempty"`
// Soft size limit in bytes for access log entries buffer. The logger will buffer requests until
// this limit it hit, or every time flush interval is elapsed, whichever comes first. When the buffer
// limit is hit, the logger will immediately flush the buffer contents. Setting it to zero effectively
// disables the batching. Defaults to 16384.
BufferSizeBytes *wrapperspb.UInt32Value `protobuf:"bytes,5,opt,name=buffer_size_bytes,json=bufferSizeBytes,proto3" json:"buffer_size_bytes,omitempty"`
// A struct that represents the record that is sent for each log entry.
// https://github.com/fluent/fluentd/wiki/Forward-Protocol-Specification-v1#entry
// 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 :ref:`format string<config_access_log_format_strings>` documentation for a specific command operator details.
//
// .. validated-code-block:: yaml
//
// :type-name: envoy.extensions.access_loggers.fluentd.v3.FluentdAccessLogConfig
//
// record:
// status: "%RESPONSE_CODE%"
// message: "%LOCAL_REPLY_BODY%"
//
// The following msgpack record would be created:
//
// .. code-block:: json
//
// {
// "status": 500,
// "message": "My error message"
// }
Record *structpb.Struct `protobuf:"bytes,6,opt,name=record,proto3" json:"record,omitempty"`
// Optional retry, in case upstream connection has failed. If this field is not set, the default values will be applied,
// as specified in the :ref:`RetryOptions <envoy_v3_api_msg_extensions.access_loggers.fluentd.v3.FluentdAccessLogConfig.RetryOptions>`
// configuration.
RetryOptions *FluentdAccessLogConfig_RetryOptions `protobuf:"bytes,7,opt,name=retry_options,json=retryOptions,proto3" json:"retry_options,omitempty"`
// Specifies a collection of Formatter plugins that can be called from the access log configuration.
// See the formatters extensions documentation for details.
// [#extension-category: envoy.formatter]
Formatters []*v3.TypedExtensionConfig `protobuf:"bytes,8,rep,name=formatters,proto3" json:"formatters,omitempty"`
// contains filtered or unexported fields
}
Configuration for the *envoy.access_loggers.fluentd* :ref:`AccessLog <envoy_v3_api_msg_config.accesslog.v3.AccessLog>`. This access log extension will send the emitted access logs over a TCP connection to an upstream that is accepting the Fluentd Forward Protocol as described in: `Fluentd Forward Protocol Specification <https://github.com/fluent/fluentd/wiki/Forward-Protocol-Specification-v1>`_. [#extension: envoy.access_loggers.fluentd] [#next-free-field: 9]
func (*FluentdAccessLogConfig) Descriptor
deprecated
func (*FluentdAccessLogConfig) Descriptor() ([]byte, []int)
Deprecated: Use FluentdAccessLogConfig.ProtoReflect.Descriptor instead.
func (*FluentdAccessLogConfig) GetBufferFlushInterval ¶
func (x *FluentdAccessLogConfig) GetBufferFlushInterval() *durationpb.Duration
func (*FluentdAccessLogConfig) GetBufferSizeBytes ¶
func (x *FluentdAccessLogConfig) GetBufferSizeBytes() *wrapperspb.UInt32Value
func (*FluentdAccessLogConfig) GetCluster ¶
func (x *FluentdAccessLogConfig) GetCluster() string
func (*FluentdAccessLogConfig) GetFormatters ¶
func (x *FluentdAccessLogConfig) GetFormatters() []*v3.TypedExtensionConfig
func (*FluentdAccessLogConfig) GetRecord ¶
func (x *FluentdAccessLogConfig) GetRecord() *structpb.Struct
func (*FluentdAccessLogConfig) GetRetryOptions ¶
func (x *FluentdAccessLogConfig) GetRetryOptions() *FluentdAccessLogConfig_RetryOptions
func (*FluentdAccessLogConfig) GetStatPrefix ¶
func (x *FluentdAccessLogConfig) GetStatPrefix() string
func (*FluentdAccessLogConfig) GetTag ¶
func (x *FluentdAccessLogConfig) GetTag() string
func (*FluentdAccessLogConfig) ProtoMessage ¶
func (*FluentdAccessLogConfig) ProtoMessage()
func (*FluentdAccessLogConfig) ProtoReflect ¶
func (x *FluentdAccessLogConfig) ProtoReflect() protoreflect.Message
func (*FluentdAccessLogConfig) Reset ¶
func (x *FluentdAccessLogConfig) Reset()
func (*FluentdAccessLogConfig) String ¶
func (x *FluentdAccessLogConfig) String() string
type FluentdAccessLogConfig_RetryOptions ¶
type FluentdAccessLogConfig_RetryOptions struct {
// The number of times the logger will attempt to connect to the upstream during reconnects.
// By default, there is no limit. The logger will attempt to reconnect to the upstream each time
// connecting to the upstream failed or the upstream connection had been closed for any reason.
MaxConnectAttempts *wrapperspb.UInt32Value `protobuf:"bytes,1,opt,name=max_connect_attempts,json=maxConnectAttempts,proto3" json:"max_connect_attempts,omitempty"`
// Sets the backoff strategy. If this value is not set, the default base backoff interval is 500
// milliseconds and the default max backoff interval is 5 seconds (10 times the base interval).
BackoffOptions *v3.BackoffStrategy `protobuf:"bytes,2,opt,name=backoff_options,json=backoffOptions,proto3" json:"backoff_options,omitempty"`
// contains filtered or unexported fields
}
func (*FluentdAccessLogConfig_RetryOptions) Descriptor
deprecated
func (*FluentdAccessLogConfig_RetryOptions) Descriptor() ([]byte, []int)
Deprecated: Use FluentdAccessLogConfig_RetryOptions.ProtoReflect.Descriptor instead.
func (*FluentdAccessLogConfig_RetryOptions) GetBackoffOptions ¶
func (x *FluentdAccessLogConfig_RetryOptions) GetBackoffOptions() *v3.BackoffStrategy
func (*FluentdAccessLogConfig_RetryOptions) GetMaxConnectAttempts ¶
func (x *FluentdAccessLogConfig_RetryOptions) GetMaxConnectAttempts() *wrapperspb.UInt32Value
func (*FluentdAccessLogConfig_RetryOptions) ProtoMessage ¶
func (*FluentdAccessLogConfig_RetryOptions) ProtoMessage()
func (*FluentdAccessLogConfig_RetryOptions) ProtoReflect ¶
func (x *FluentdAccessLogConfig_RetryOptions) ProtoReflect() protoreflect.Message
func (*FluentdAccessLogConfig_RetryOptions) Reset ¶
func (x *FluentdAccessLogConfig_RetryOptions) Reset()
func (*FluentdAccessLogConfig_RetryOptions) String ¶
func (x *FluentdAccessLogConfig_RetryOptions) String() string
Click to show internal directories.
Click to hide internal directories.