tcp_statsv3

Documentation

Index

• Variables
• type Config
  • func (*Config) Descriptor() ([]byte, []int)
  • func (x *Config) GetTransportSocket() *v3.TransportSocket
  • func (x *Config) GetUpdatePeriod() *duration.Duration
  • func (*Config) ProtoMessage()
  • func (x *Config) ProtoReflect() protoreflect.Message
  • func (x *Config) Reset()
  • func (x *Config) String() string
  • func (m *Config) Validate() error
  • func (m *Config) ValidateAll() error
• type ConfigMultiError
  • func (m ConfigMultiError) AllErrors() []error
  • func (m ConfigMultiError) Error() string
• type ConfigValidationError
  • func (e ConfigValidationError) Cause() error
  • func (e ConfigValidationError) Error() string
  • func (e ConfigValidationError) ErrorName() string
  • func (e ConfigValidationError) Field() string
  • func (e ConfigValidationError) Key() bool
  • func (e ConfigValidationError) Reason() string

Variables

var File_envoy_extensions_transport_sockets_tcp_stats_v3_tcp_stats_proto protoreflect.FileDescriptor

Types

type Config

type Config struct {

	// The underlying transport socket being wrapped.
	TransportSocket *v3.TransportSocket `protobuf:"bytes,1,opt,name=transport_socket,json=transportSocket,proto3" json:"transport_socket,omitempty"`
	// Period to update stats while the connection is open. If unset, updates only happen when the
	// connection is closed. Stats are always updated one final time when the connection is closed.
	UpdatePeriod *duration.Duration `protobuf:"bytes,2,opt,name=update_period,json=updatePeriod,proto3" json:"update_period,omitempty"`
	// contains filtered or unexported fields
}

Configuration for the TCP Stats transport socket wrapper, which wraps another transport socket for all communication, but emits stats about the underlying TCP connection.

The stats are documented :ref:`here <config_listener_stats_tcp>` for listeners and :ref:`here <config_cluster_manager_cluster_stats_tcp>` for clusters.

This transport socket is currently only supported on Linux.

func (*Config) Descriptor

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

Deprecated: Use Config.ProtoReflect.Descriptor instead.

func (*Config) GetTransportSocket

func (x *Config) GetTransportSocket() *v3.TransportSocket

func (*Config) GetUpdatePeriod

func (x *Config) GetUpdatePeriod() *duration.Duration

func (*Config) ProtoMessage

func (*Config) ProtoMessage()

func (*Config) ProtoReflect

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

func (*Config) Reset

func (x *Config) Reset()

func (*Config) String

func (x *Config) String() string

func (*Config) Validate

func (m *Config) Validate() error

Validate checks the field values on Config 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 (*Config) ValidateAll

func (m *Config) ValidateAll() error

ValidateAll checks the field values on Config 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 ConfigMultiError, or nil if none found.

type ConfigMultiError

type ConfigMultiError []error

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

func (ConfigMultiError) AllErrors

func (m ConfigMultiError) AllErrors() []error

AllErrors returns a list of validation violation errors.

func (ConfigMultiError) Error

func (m ConfigMultiError) Error() string

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

type ConfigValidationError

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

ConfigValidationError is the validation error returned by Config.Validate if the designated constraints aren't met.

func (ConfigValidationError) Cause

func (e ConfigValidationError) Cause() error

Cause function returns cause value.

func (ConfigValidationError) Error

func (e ConfigValidationError) Error() string

Error satisfies the builtin error interface

func (ConfigValidationError) ErrorName

func (e ConfigValidationError) ErrorName() string

ErrorName returns error name.

func (ConfigValidationError) Field

func (e ConfigValidationError) Field() string

Field function returns field value.

func (ConfigValidationError) Key

func (e ConfigValidationError) Key() bool

Key function returns key value.

func (ConfigValidationError) Reason

func (e ConfigValidationError) Reason() string

Reason function returns reason value.