fluentdv3

package
v3.10.0-rc.0 Latest Latest
Warning

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

 Go to latest Published: Aug 20, 2024 License: Apache-2.0 Imports: 22 Imported by: 0

Documentation

Index

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

func (*FluentdAccessLogConfig) Validate 

func (m *FluentdAccessLogConfig) Validate() error

Validate checks the field values on FluentdAccessLogConfig with the rules defined in the proto definition for this message. If any rules are violated, the first error encountered is returned, or nil if there are no violations.

func (*FluentdAccessLogConfig) ValidateAll 

func (m *FluentdAccessLogConfig) ValidateAll() error

ValidateAll checks the field values on FluentdAccessLogConfig with the rules defined in the proto definition for this message. If any rules are violated, the result is a list of violation errors wrapped in FluentdAccessLogConfigMultiError, or nil if none found.

type FluentdAccessLogConfigMultiError 

type FluentdAccessLogConfigMultiError []error

FluentdAccessLogConfigMultiError is an error wrapping multiple validation errors returned by FluentdAccessLogConfig.ValidateAll() if the designated constraints aren't met.

func (FluentdAccessLogConfigMultiError) AllErrors 

func (m FluentdAccessLogConfigMultiError) AllErrors() []error

AllErrors returns a list of validation violation errors.

func (FluentdAccessLogConfigMultiError) Error 

func (m FluentdAccessLogConfigMultiError) Error() string

Error returns a concatenation of all the error messages it wraps.

type FluentdAccessLogConfigValidationError 

type FluentdAccessLogConfigValidationError struct {
	// contains filtered or unexported fields
}

FluentdAccessLogConfigValidationError is the validation error returned by FluentdAccessLogConfig.Validate if the designated constraints aren't met.

func (FluentdAccessLogConfigValidationError) Cause 

func (e FluentdAccessLogConfigValidationError) Cause() error

Cause function returns cause value.

func (FluentdAccessLogConfigValidationError) Error 

func (e FluentdAccessLogConfigValidationError) Error() string

Error satisfies the builtin error interface

func (FluentdAccessLogConfigValidationError) ErrorName 

func (e FluentdAccessLogConfigValidationError) ErrorName() string

ErrorName returns error name.

func (FluentdAccessLogConfigValidationError) Field 

func (e FluentdAccessLogConfigValidationError) Field() string

Field function returns field value.

func (FluentdAccessLogConfigValidationError) Key 

func (e FluentdAccessLogConfigValidationError) Key() bool

Key function returns key value.

func (FluentdAccessLogConfigValidationError) Reason 

func (e FluentdAccessLogConfigValidationError) Reason() string

Reason function returns reason value.

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

func (*FluentdAccessLogConfig_RetryOptions) Validate 

func (m *FluentdAccessLogConfig_RetryOptions) Validate() error

Validate checks the field values on FluentdAccessLogConfig_RetryOptions with the rules defined in the proto definition for this message. If any rules are violated, the first error encountered is returned, or nil if there are no violations.

func (*FluentdAccessLogConfig_RetryOptions) ValidateAll 

func (m *FluentdAccessLogConfig_RetryOptions) ValidateAll() error

ValidateAll checks the field values on FluentdAccessLogConfig_RetryOptions with the rules defined in the proto definition for this message. If any rules are violated, the result is a list of violation errors wrapped in FluentdAccessLogConfig_RetryOptionsMultiError, or nil if none found.

type FluentdAccessLogConfig_RetryOptionsMultiError 

type FluentdAccessLogConfig_RetryOptionsMultiError []error

FluentdAccessLogConfig_RetryOptionsMultiError is an error wrapping multiple validation errors returned by FluentdAccessLogConfig_RetryOptions.ValidateAll() if the designated constraints aren't met.

func (FluentdAccessLogConfig_RetryOptionsMultiError) AllErrors 

func (m FluentdAccessLogConfig_RetryOptionsMultiError) AllErrors() []error

AllErrors returns a list of validation violation errors.

func (FluentdAccessLogConfig_RetryOptionsMultiError) Error 

func (m FluentdAccessLogConfig_RetryOptionsMultiError) Error() string

Error returns a concatenation of all the error messages it wraps.

type FluentdAccessLogConfig_RetryOptionsValidationError 

type FluentdAccessLogConfig_RetryOptionsValidationError struct {
	// contains filtered or unexported fields
}

FluentdAccessLogConfig_RetryOptionsValidationError is the validation error returned by FluentdAccessLogConfig_RetryOptions.Validate if the designated constraints aren't met.

func (FluentdAccessLogConfig_RetryOptionsValidationError) Cause 

func (e FluentdAccessLogConfig_RetryOptionsValidationError) Cause() error

Cause function returns cause value.

func (FluentdAccessLogConfig_RetryOptionsValidationError) Error 

func (e FluentdAccessLogConfig_RetryOptionsValidationError) Error() string

Error satisfies the builtin error interface

func (FluentdAccessLogConfig_RetryOptionsValidationError) ErrorName 

func (e FluentdAccessLogConfig_RetryOptionsValidationError) ErrorName() string

ErrorName returns error name.

func (FluentdAccessLogConfig_RetryOptionsValidationError) Field 

func (e FluentdAccessLogConfig_RetryOptionsValidationError) Field() string

Field function returns field value.

func (FluentdAccessLogConfig_RetryOptionsValidationError) Key 

func (e FluentdAccessLogConfig_RetryOptionsValidationError) Key() bool

Key function returns key value.

func (FluentdAccessLogConfig_RetryOptionsValidationError) Reason 

func (e FluentdAccessLogConfig_RetryOptionsValidationError) Reason() string

Reason function returns reason value.

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.