metricsv2

package
v0.13.1 Latest Latest
Warning

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

 Go to latest Published: Oct 15, 2024 License: Apache-2.0 Imports: 22 Imported by: 27

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var File_envoy_config_metrics_v2_metrics_service_proto protoreflect.FileDescriptor
View Source 
var File_envoy_config_metrics_v2_stats_proto protoreflect.FileDescriptor

Functions

This section is empty.

Types

type DogStatsdSink 

type DogStatsdSink struct {

	// Types that are assignable to DogStatsdSpecifier:
	//
	//	*DogStatsdSink_Address
	DogStatsdSpecifier isDogStatsdSink_DogStatsdSpecifier `protobuf_oneof:"dog_statsd_specifier"`
	// Optional custom metric name prefix. See :ref:`StatsdSink's prefix field
	// <envoy_api_field_config.metrics.v2.StatsdSink.prefix>` for more details.
	Prefix string `protobuf:"bytes,3,opt,name=prefix,proto3" json:"prefix,omitempty"`
	// contains filtered or unexported fields
}

Stats configuration proto schema for built-in *envoy.stat_sinks.dog_statsd* sink. The sink emits stats with `DogStatsD <https://docs.datadoghq.com/guides/dogstatsd/>`_ compatible tags. Tags are configurable via :ref:`StatsConfig <envoy_api_msg_config.metrics.v2.StatsConfig>`. [#extension: envoy.stat_sinks.dog_statsd]

func (*DogStatsdSink) Descriptor deprecated 

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

Deprecated: Use DogStatsdSink.ProtoReflect.Descriptor instead.

func (*DogStatsdSink) GetAddress 

func (x *DogStatsdSink) GetAddress() *core.Address

func (*DogStatsdSink) GetDogStatsdSpecifier 

func (m *DogStatsdSink) GetDogStatsdSpecifier() isDogStatsdSink_DogStatsdSpecifier

func (*DogStatsdSink) GetPrefix added in v0.6.1 

func (x *DogStatsdSink) GetPrefix() string

func (*DogStatsdSink) ProtoMessage 

func (*DogStatsdSink) ProtoMessage()

func (*DogStatsdSink) ProtoReflect added in v0.9.6 

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

func (*DogStatsdSink) Reset 

func (x *DogStatsdSink) Reset()

func (*DogStatsdSink) String 

func (x *DogStatsdSink) String() string

func (*DogStatsdSink) Validate 

func (m *DogStatsdSink) Validate() error

Validate checks the field values on DogStatsdSink 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 (*DogStatsdSink) ValidateAll added in v0.10.0 

func (m *DogStatsdSink) ValidateAll() error

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

type DogStatsdSinkMultiError added in v0.10.0 

type DogStatsdSinkMultiError []error

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

func (DogStatsdSinkMultiError) AllErrors added in v0.10.0 

func (m DogStatsdSinkMultiError) AllErrors() []error

AllErrors returns a list of validation violation errors.

func (DogStatsdSinkMultiError) Error added in v0.10.0 

func (m DogStatsdSinkMultiError) Error() string

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

type DogStatsdSinkValidationError 

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

DogStatsdSinkValidationError is the validation error returned by DogStatsdSink.Validate if the designated constraints aren't met.

func (DogStatsdSinkValidationError) Cause 

func (e DogStatsdSinkValidationError) Cause() error

Cause function returns cause value.

func (DogStatsdSinkValidationError) Error 

func (e DogStatsdSinkValidationError) Error() string

Error satisfies the builtin error interface

func (DogStatsdSinkValidationError) ErrorName added in v0.7.0 

func (e DogStatsdSinkValidationError) ErrorName() string

ErrorName returns error name.

func (DogStatsdSinkValidationError) Field 

func (e DogStatsdSinkValidationError) Field() string

Field function returns field value.

func (DogStatsdSinkValidationError) Key 

func (e DogStatsdSinkValidationError) Key() bool

Key function returns key value.

func (DogStatsdSinkValidationError) Reason 

func (e DogStatsdSinkValidationError) Reason() string

Reason function returns reason value.

type DogStatsdSink_Address 

type DogStatsdSink_Address struct {
	// The UDP address of a running DogStatsD compliant listener. If specified,
	// statistics will be flushed to this address.
	Address *core.Address `protobuf:"bytes,1,opt,name=address,proto3,oneof"`
}

type HystrixSink 

type HystrixSink struct {

	// The number of buckets the rolling statistical window is divided into.
	//
	// Each time the sink is flushed, all relevant Envoy statistics are sampled and
	// added to the rolling window (removing the oldest samples in the window
	// in the process). The sink then outputs the aggregate statistics across the
	// current rolling window to the event stream(s).
	//
	// rolling_window(ms) = stats_flush_interval(ms) * num_of_buckets
	//
	// More detailed explanation can be found in `Hystrix wiki
	// <https://github.com/Netflix/Hystrix/wiki/Metrics-and-Monitoring#hystrixrollingnumber>`_.
	NumBuckets int64 `protobuf:"varint,1,opt,name=num_buckets,json=numBuckets,proto3" json:"num_buckets,omitempty"`
	// contains filtered or unexported fields
}

Stats configuration proto schema for built-in *envoy.stat_sinks.hystrix* sink. The sink emits stats in `text/event-stream <https://developer.mozilla.org/en-US/docs/Web/API/Server-sent_events/Using_server-sent_events>`_ formatted stream for use by `Hystrix dashboard <https://github.com/Netflix-Skunkworks/hystrix-dashboard/wiki>`_.

Note that only a single HystrixSink should be configured.

Streaming is started through an admin endpoint :http:get:`/hystrix_event_stream`. [#extension: envoy.stat_sinks.hystrix]

func (*HystrixSink) Descriptor deprecated 

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

Deprecated: Use HystrixSink.ProtoReflect.Descriptor instead.

func (*HystrixSink) GetNumBuckets 

func (x *HystrixSink) GetNumBuckets() int64

func (*HystrixSink) ProtoMessage 

func (*HystrixSink) ProtoMessage()

func (*HystrixSink) ProtoReflect added in v0.9.6 

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

func (*HystrixSink) Reset 

func (x *HystrixSink) Reset()

func (*HystrixSink) String 

func (x *HystrixSink) String() string

func (*HystrixSink) Validate 

func (m *HystrixSink) Validate() error

Validate checks the field values on HystrixSink 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 (*HystrixSink) ValidateAll added in v0.10.0 

func (m *HystrixSink) ValidateAll() error

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

type HystrixSinkMultiError added in v0.10.0 

type HystrixSinkMultiError []error

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

func (HystrixSinkMultiError) AllErrors added in v0.10.0 

func (m HystrixSinkMultiError) AllErrors() []error

AllErrors returns a list of validation violation errors.

func (HystrixSinkMultiError) Error added in v0.10.0 

func (m HystrixSinkMultiError) Error() string

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

type HystrixSinkValidationError 

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

HystrixSinkValidationError is the validation error returned by HystrixSink.Validate if the designated constraints aren't met.

func (HystrixSinkValidationError) Cause 

func (e HystrixSinkValidationError) Cause() error

Cause function returns cause value.

func (HystrixSinkValidationError) Error 

func (e HystrixSinkValidationError) Error() string

Error satisfies the builtin error interface

func (HystrixSinkValidationError) ErrorName added in v0.7.0 

func (e HystrixSinkValidationError) ErrorName() string

ErrorName returns error name.

func (HystrixSinkValidationError) Field 

func (e HystrixSinkValidationError) Field() string

Field function returns field value.

func (HystrixSinkValidationError) Key 

func (e HystrixSinkValidationError) Key() bool

Key function returns key value.

func (HystrixSinkValidationError) Reason 

func (e HystrixSinkValidationError) Reason() string

Reason function returns reason value.

type MetricsServiceConfig 

type MetricsServiceConfig struct {

	// The upstream gRPC cluster that hosts the metrics service.
	GrpcService *core.GrpcService `protobuf:"bytes,1,opt,name=grpc_service,json=grpcService,proto3" json:"grpc_service,omitempty"`
	// contains filtered or unexported fields
}

Metrics Service is configured as a built-in *envoy.stat_sinks.metrics_service* :ref:`StatsSink <envoy_api_msg_config.metrics.v2.StatsSink>`. This opaque configuration will be used to create Metrics Service. [#extension: envoy.stat_sinks.metrics_service]

func (*MetricsServiceConfig) Descriptor deprecated 

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

Deprecated: Use MetricsServiceConfig.ProtoReflect.Descriptor instead.

func (*MetricsServiceConfig) GetGrpcService 

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

func (*MetricsServiceConfig) ProtoMessage 

func (*MetricsServiceConfig) ProtoMessage()

func (*MetricsServiceConfig) ProtoReflect added in v0.9.6 

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

func (*MetricsServiceConfig) Reset 

func (x *MetricsServiceConfig) Reset()

func (*MetricsServiceConfig) String 

func (x *MetricsServiceConfig) String() string

func (*MetricsServiceConfig) Validate 

func (m *MetricsServiceConfig) Validate() error

Validate checks the field values on MetricsServiceConfig 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 (*MetricsServiceConfig) ValidateAll added in v0.10.0 

func (m *MetricsServiceConfig) ValidateAll() error

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

type MetricsServiceConfigMultiError added in v0.10.0 

type MetricsServiceConfigMultiError []error

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

func (MetricsServiceConfigMultiError) AllErrors added in v0.10.0 

func (m MetricsServiceConfigMultiError) AllErrors() []error

AllErrors returns a list of validation violation errors.

func (MetricsServiceConfigMultiError) Error added in v0.10.0 

func (m MetricsServiceConfigMultiError) Error() string

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

type MetricsServiceConfigValidationError 

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

MetricsServiceConfigValidationError is the validation error returned by MetricsServiceConfig.Validate if the designated constraints aren't met.

func (MetricsServiceConfigValidationError) Cause 

func (e MetricsServiceConfigValidationError) Cause() error

Cause function returns cause value.

func (MetricsServiceConfigValidationError) Error 

func (e MetricsServiceConfigValidationError) Error() string

Error satisfies the builtin error interface

func (MetricsServiceConfigValidationError) ErrorName added in v0.7.0 

func (e MetricsServiceConfigValidationError) ErrorName() string

ErrorName returns error name.

func (MetricsServiceConfigValidationError) Field 

func (e MetricsServiceConfigValidationError) Field() string

Field function returns field value.

func (MetricsServiceConfigValidationError) Key 

func (e MetricsServiceConfigValidationError) Key() bool

Key function returns key value.

func (MetricsServiceConfigValidationError) Reason 

func (e MetricsServiceConfigValidationError) Reason() string

Reason function returns reason value.

type StatsConfig 

type StatsConfig struct {

	// Each stat name is iteratively processed through these tag specifiers.
	// When a tag is matched, the first capture group is removed from the name so
	// later :ref:`TagSpecifiers <envoy_api_msg_config.metrics.v2.TagSpecifier>` cannot match that
	// same portion of the match.
	StatsTags []*TagSpecifier `protobuf:"bytes,1,rep,name=stats_tags,json=statsTags,proto3" json:"stats_tags,omitempty"`
	// Use all default tag regexes specified in Envoy. These can be combined with
	// custom tags specified in :ref:`stats_tags
	// <envoy_api_field_config.metrics.v2.StatsConfig.stats_tags>`. They will be processed before
	// the custom tags.
	//
	// .. note::
	//
	//	If any default tags are specified twice, the config will be considered
	//	invalid.
	//
	// See :repo:`well_known_names.h <source/common/config/well_known_names.h>` for a list of the
	// default tags in Envoy.
	//
	// If not provided, the value is assumed to be true.
	UseAllDefaultTags *wrapperspb.BoolValue `protobuf:"bytes,2,opt,name=use_all_default_tags,json=useAllDefaultTags,proto3" json:"use_all_default_tags,omitempty"`
	// Inclusion/exclusion matcher for stat name creation. If not provided, all stats are instantiated
	// as normal. Preventing the instantiation of certain families of stats can improve memory
	// performance for Envoys running especially large configs.
	//
	// .. warning::
	//
	//	Excluding stats may affect Envoy's behavior in undocumented ways. See
	//	`issue #8771 <https://github.com/envoyproxy/envoy/issues/8771>`_ for more information.
	//	If any unexpected behavior changes are observed, please open a new issue immediately.
	StatsMatcher *StatsMatcher `protobuf:"bytes,3,opt,name=stats_matcher,json=statsMatcher,proto3" json:"stats_matcher,omitempty"`
	// contains filtered or unexported fields
}

Statistics configuration such as tagging.

func (*StatsConfig) Descriptor deprecated 

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

Deprecated: Use StatsConfig.ProtoReflect.Descriptor instead.

func (*StatsConfig) GetStatsMatcher added in v0.6.1 

func (x *StatsConfig) GetStatsMatcher() *StatsMatcher

func (*StatsConfig) GetStatsTags 

func (x *StatsConfig) GetStatsTags() []*TagSpecifier

func (*StatsConfig) GetUseAllDefaultTags 

func (x *StatsConfig) GetUseAllDefaultTags() *wrapperspb.BoolValue

func (*StatsConfig) ProtoMessage 

func (*StatsConfig) ProtoMessage()

func (*StatsConfig) ProtoReflect added in v0.9.6 

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

func (*StatsConfig) Reset 

func (x *StatsConfig) Reset()

func (*StatsConfig) String 

func (x *StatsConfig) String() string

func (*StatsConfig) Validate 

func (m *StatsConfig) Validate() error

Validate checks the field values on StatsConfig 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 (*StatsConfig) ValidateAll added in v0.10.0 

func (m *StatsConfig) ValidateAll() error

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

type StatsConfigMultiError added in v0.10.0 

type StatsConfigMultiError []error

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

func (StatsConfigMultiError) AllErrors added in v0.10.0 

func (m StatsConfigMultiError) AllErrors() []error

AllErrors returns a list of validation violation errors.

func (StatsConfigMultiError) Error added in v0.10.0 

func (m StatsConfigMultiError) Error() string

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

type StatsConfigValidationError 

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

StatsConfigValidationError is the validation error returned by StatsConfig.Validate if the designated constraints aren't met.

func (StatsConfigValidationError) Cause 

func (e StatsConfigValidationError) Cause() error

Cause function returns cause value.

func (StatsConfigValidationError) Error 

func (e StatsConfigValidationError) Error() string

Error satisfies the builtin error interface

func (StatsConfigValidationError) ErrorName added in v0.7.0 

func (e StatsConfigValidationError) ErrorName() string

ErrorName returns error name.

func (StatsConfigValidationError) Field 

func (e StatsConfigValidationError) Field() string

Field function returns field value.

func (StatsConfigValidationError) Key 

func (e StatsConfigValidationError) Key() bool

Key function returns key value.

func (StatsConfigValidationError) Reason 

func (e StatsConfigValidationError) Reason() string

Reason function returns reason value.

type StatsMatcher added in v0.6.1 

type StatsMatcher struct {

	// Types that are assignable to StatsMatcher:
	//
	//	*StatsMatcher_RejectAll
	//	*StatsMatcher_ExclusionList
	//	*StatsMatcher_InclusionList
	StatsMatcher isStatsMatcher_StatsMatcher `protobuf_oneof:"stats_matcher"`
	// contains filtered or unexported fields
}

Configuration for disabling stat instantiation.

func (*StatsMatcher) Descriptor deprecated added in v0.6.1 

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

Deprecated: Use StatsMatcher.ProtoReflect.Descriptor instead.

func (*StatsMatcher) GetExclusionList added in v0.6.1 

func (x *StatsMatcher) GetExclusionList() *matcher.ListStringMatcher

func (*StatsMatcher) GetInclusionList added in v0.6.1 

func (x *StatsMatcher) GetInclusionList() *matcher.ListStringMatcher

func (*StatsMatcher) GetRejectAll added in v0.6.1 

func (x *StatsMatcher) GetRejectAll() bool

func (*StatsMatcher) GetStatsMatcher added in v0.6.1 

func (m *StatsMatcher) GetStatsMatcher() isStatsMatcher_StatsMatcher

func (*StatsMatcher) ProtoMessage added in v0.6.1 

func (*StatsMatcher) ProtoMessage()

func (*StatsMatcher) ProtoReflect added in v0.9.6 

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

func (*StatsMatcher) Reset added in v0.6.1 

func (x *StatsMatcher) Reset()

func (*StatsMatcher) String added in v0.6.1 

func (x *StatsMatcher) String() string

func (*StatsMatcher) Validate added in v0.6.1 

func (m *StatsMatcher) Validate() error

Validate checks the field values on StatsMatcher 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 (*StatsMatcher) ValidateAll added in v0.10.0 

func (m *StatsMatcher) ValidateAll() error

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

type StatsMatcherMultiError added in v0.10.0 

type StatsMatcherMultiError []error

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

func (StatsMatcherMultiError) AllErrors added in v0.10.0 

func (m StatsMatcherMultiError) AllErrors() []error

AllErrors returns a list of validation violation errors.

func (StatsMatcherMultiError) Error added in v0.10.0 

func (m StatsMatcherMultiError) Error() string

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

type StatsMatcherValidationError added in v0.6.1 

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

StatsMatcherValidationError is the validation error returned by StatsMatcher.Validate if the designated constraints aren't met.

func (StatsMatcherValidationError) Cause added in v0.6.1 

func (e StatsMatcherValidationError) Cause() error

Cause function returns cause value.

func (StatsMatcherValidationError) Error added in v0.6.1 

func (e StatsMatcherValidationError) Error() string

Error satisfies the builtin error interface

func (StatsMatcherValidationError) ErrorName added in v0.7.0 

func (e StatsMatcherValidationError) ErrorName() string

ErrorName returns error name.

func (StatsMatcherValidationError) Field added in v0.6.1 

func (e StatsMatcherValidationError) Field() string

Field function returns field value.

func (StatsMatcherValidationError) Key added in v0.6.1 

func (e StatsMatcherValidationError) Key() bool

Key function returns key value.

func (StatsMatcherValidationError) Reason added in v0.6.1 

func (e StatsMatcherValidationError) Reason() string

Reason function returns reason value.

type StatsMatcher_ExclusionList added in v0.6.1 

type StatsMatcher_ExclusionList struct {
	// Exclusive match. All stats are enabled except for those matching one of the supplied
	// StringMatcher protos.
	ExclusionList *matcher.ListStringMatcher `protobuf:"bytes,2,opt,name=exclusion_list,json=exclusionList,proto3,oneof"`
}

type StatsMatcher_InclusionList added in v0.6.1 

type StatsMatcher_InclusionList struct {
	// Inclusive match. No stats are enabled except for those matching one of the supplied
	// StringMatcher protos.
	InclusionList *matcher.ListStringMatcher `protobuf:"bytes,3,opt,name=inclusion_list,json=inclusionList,proto3,oneof"`
}

type StatsMatcher_RejectAll added in v0.6.1 

type StatsMatcher_RejectAll struct {
	// If `reject_all` is true, then all stats are disabled. If `reject_all` is false, then all
	// stats are enabled.
	RejectAll bool `protobuf:"varint,1,opt,name=reject_all,json=rejectAll,proto3,oneof"`
}

type StatsSink 

type StatsSink struct {

	// The name of the stats sink to instantiate. The name must match a supported
	// stats sink. The built-in stats sinks are:
	//
	// * :ref:`envoy.stat_sinks.statsd <envoy_api_msg_config.metrics.v2.StatsdSink>`
	// * :ref:`envoy.stat_sinks.dog_statsd <envoy_api_msg_config.metrics.v2.DogStatsdSink>`
	// * :ref:`envoy.stat_sinks.metrics_service <envoy_api_msg_config.metrics.v2.MetricsServiceConfig>`
	// * :ref:`envoy.stat_sinks.hystrix <envoy_api_msg_config.metrics.v2.HystrixSink>`
	//
	// Sinks optionally support tagged/multiple dimensional metrics.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Stats sink specific configuration which depends on the sink being instantiated. See
	// :ref:`StatsdSink <envoy_api_msg_config.metrics.v2.StatsdSink>` for an example.
	//
	// Types that are assignable to ConfigType:
	//
	//	*StatsSink_Config
	//	*StatsSink_TypedConfig
	ConfigType isStatsSink_ConfigType `protobuf_oneof:"config_type"`
	// contains filtered or unexported fields
}

Configuration for pluggable stats sinks.

func (*StatsSink) Descriptor deprecated 

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

Deprecated: Use StatsSink.ProtoReflect.Descriptor instead.

func (*StatsSink) GetConfig deprecated 

func (x *StatsSink) GetConfig() *structpb.Struct

Deprecated: Marked as deprecated in envoy/config/metrics/v2/stats.proto.

func (*StatsSink) GetConfigType added in v0.6.3 

func (m *StatsSink) GetConfigType() isStatsSink_ConfigType

func (*StatsSink) GetName 

func (x *StatsSink) GetName() string

func (*StatsSink) GetTypedConfig added in v0.6.3 

func (x *StatsSink) GetTypedConfig() *anypb.Any

func (*StatsSink) ProtoMessage 

func (*StatsSink) ProtoMessage()

func (*StatsSink) ProtoReflect added in v0.9.6 

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

func (*StatsSink) Reset 

func (x *StatsSink) Reset()

func (*StatsSink) String 

func (x *StatsSink) String() string

func (*StatsSink) Validate 

func (m *StatsSink) Validate() error

Validate checks the field values on StatsSink 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 (*StatsSink) ValidateAll added in v0.10.0 

func (m *StatsSink) ValidateAll() error

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

type StatsSinkMultiError added in v0.10.0 

type StatsSinkMultiError []error

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

func (StatsSinkMultiError) AllErrors added in v0.10.0 

func (m StatsSinkMultiError) AllErrors() []error

AllErrors returns a list of validation violation errors.

func (StatsSinkMultiError) Error added in v0.10.0 

func (m StatsSinkMultiError) Error() string

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

type StatsSinkValidationError 

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

StatsSinkValidationError is the validation error returned by StatsSink.Validate if the designated constraints aren't met.

func (StatsSinkValidationError) Cause 

func (e StatsSinkValidationError) Cause() error

Cause function returns cause value.

func (StatsSinkValidationError) Error 

func (e StatsSinkValidationError) Error() string

Error satisfies the builtin error interface

func (StatsSinkValidationError) ErrorName added in v0.7.0 

func (e StatsSinkValidationError) ErrorName() string

ErrorName returns error name.

func (StatsSinkValidationError) Field 

func (e StatsSinkValidationError) Field() string

Field function returns field value.

func (StatsSinkValidationError) Key 

func (e StatsSinkValidationError) Key() bool

Key function returns key value.

func (StatsSinkValidationError) Reason 

func (e StatsSinkValidationError) Reason() string

Reason function returns reason value.

type StatsSink_Config added in v0.6.3 

type StatsSink_Config struct {
	// Deprecated: Marked as deprecated in envoy/config/metrics/v2/stats.proto.
	Config *structpb.Struct `protobuf:"bytes,2,opt,name=config,proto3,oneof"`
}

type StatsSink_TypedConfig added in v0.6.3 

type StatsSink_TypedConfig struct {
	TypedConfig *anypb.Any `protobuf:"bytes,3,opt,name=typed_config,json=typedConfig,proto3,oneof"`
}

type StatsdSink 

type StatsdSink struct {

	// Types that are assignable to StatsdSpecifier:
	//
	//	*StatsdSink_Address
	//	*StatsdSink_TcpClusterName
	StatsdSpecifier isStatsdSink_StatsdSpecifier `protobuf_oneof:"statsd_specifier"`
	// Optional custom prefix for StatsdSink. If
	// specified, this will override the default prefix.
	// For example:
	//
	// .. code-block:: json
	//
	//	{
	//	  "prefix" : "envoy-prod"
	//	}
	//
	// will change emitted stats to
	//
	// .. code-block:: cpp
	//
	//	envoy-prod.test_counter:1|c
	//	envoy-prod.test_timer:5|ms
	//
	// Note that the default prefix, "envoy", will be used if a prefix is not
	// specified.
	//
	// Stats with default prefix:
	//
	// .. code-block:: cpp
	//
	//	envoy.test_counter:1|c
	//	envoy.test_timer:5|ms
	Prefix string `protobuf:"bytes,3,opt,name=prefix,proto3" json:"prefix,omitempty"`
	// contains filtered or unexported fields
}

Stats configuration proto schema for built-in *envoy.stat_sinks.statsd* sink. This sink does not support tagged metrics. [#extension: envoy.stat_sinks.statsd]

func (*StatsdSink) Descriptor deprecated 

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

Deprecated: Use StatsdSink.ProtoReflect.Descriptor instead.

func (*StatsdSink) GetAddress 

func (x *StatsdSink) GetAddress() *core.Address

func (*StatsdSink) GetPrefix 

func (x *StatsdSink) GetPrefix() string

func (*StatsdSink) GetStatsdSpecifier 

func (m *StatsdSink) GetStatsdSpecifier() isStatsdSink_StatsdSpecifier

func (*StatsdSink) GetTcpClusterName 

func (x *StatsdSink) GetTcpClusterName() string

func (*StatsdSink) ProtoMessage 

func (*StatsdSink) ProtoMessage()

func (*StatsdSink) ProtoReflect added in v0.9.6 

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

func (*StatsdSink) Reset 

func (x *StatsdSink) Reset()

func (*StatsdSink) String 

func (x *StatsdSink) String() string

func (*StatsdSink) Validate 

func (m *StatsdSink) Validate() error

Validate checks the field values on StatsdSink 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 (*StatsdSink) ValidateAll added in v0.10.0 

func (m *StatsdSink) ValidateAll() error

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

type StatsdSinkMultiError added in v0.10.0 

type StatsdSinkMultiError []error

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

func (StatsdSinkMultiError) AllErrors added in v0.10.0 

func (m StatsdSinkMultiError) AllErrors() []error

AllErrors returns a list of validation violation errors.

func (StatsdSinkMultiError) Error added in v0.10.0 

func (m StatsdSinkMultiError) Error() string

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

type StatsdSinkValidationError 

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

StatsdSinkValidationError is the validation error returned by StatsdSink.Validate if the designated constraints aren't met.

func (StatsdSinkValidationError) Cause 

func (e StatsdSinkValidationError) Cause() error

Cause function returns cause value.

func (StatsdSinkValidationError) Error 

func (e StatsdSinkValidationError) Error() string

Error satisfies the builtin error interface

func (StatsdSinkValidationError) ErrorName added in v0.7.0 

func (e StatsdSinkValidationError) ErrorName() string

ErrorName returns error name.

func (StatsdSinkValidationError) Field 

func (e StatsdSinkValidationError) Field() string

Field function returns field value.

func (StatsdSinkValidationError) Key 

func (e StatsdSinkValidationError) Key() bool

Key function returns key value.

func (StatsdSinkValidationError) Reason 

func (e StatsdSinkValidationError) Reason() string

Reason function returns reason value.

type StatsdSink_Address 

type StatsdSink_Address struct {
	// The UDP address of a running `statsd <https://github.com/etsy/statsd>`_
	// compliant listener. If specified, statistics will be flushed to this
	// address.
	Address *core.Address `protobuf:"bytes,1,opt,name=address,proto3,oneof"`
}

type StatsdSink_TcpClusterName 

type StatsdSink_TcpClusterName struct {
	// The name of a cluster that is running a TCP `statsd
	// <https://github.com/etsy/statsd>`_ compliant listener. If specified,
	// Envoy will connect to this cluster to flush statistics.
	TcpClusterName string `protobuf:"bytes,2,opt,name=tcp_cluster_name,json=tcpClusterName,proto3,oneof"`
}

type TagSpecifier 

type TagSpecifier struct {

	// Attaches an identifier to the tag values to identify the tag being in the
	// sink. Envoy has a set of default names and regexes to extract dynamic
	// portions of existing stats, which can be found in :repo:`well_known_names.h
	// <source/common/config/well_known_names.h>` in the Envoy repository. If a :ref:`tag_name
	// <envoy_api_field_config.metrics.v2.TagSpecifier.tag_name>` is provided in the config and
	// neither :ref:`regex <envoy_api_field_config.metrics.v2.TagSpecifier.regex>` or
	// :ref:`fixed_value <envoy_api_field_config.metrics.v2.TagSpecifier.fixed_value>` were specified,
	// Envoy will attempt to find that name in its set of defaults and use the accompanying regex.
	//
	// .. note::
	//
	//	It is invalid to specify the same tag name twice in a config.
	TagName string `protobuf:"bytes,1,opt,name=tag_name,json=tagName,proto3" json:"tag_name,omitempty"`
	// Types that are assignable to TagValue:
	//
	//	*TagSpecifier_Regex
	//	*TagSpecifier_FixedValue
	TagValue isTagSpecifier_TagValue `protobuf_oneof:"tag_value"`
	// contains filtered or unexported fields
}

Designates a tag name and value pair. The value may be either a fixed value or a regex providing the value via capture groups. The specified tag will be unconditionally set if a fixed value, otherwise it will only be set if one or more capture groups in the regex match.

func (*TagSpecifier) Descriptor deprecated 

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

Deprecated: Use TagSpecifier.ProtoReflect.Descriptor instead.

func (*TagSpecifier) GetFixedValue 

func (x *TagSpecifier) GetFixedValue() string

func (*TagSpecifier) GetRegex 

func (x *TagSpecifier) GetRegex() string

func (*TagSpecifier) GetTagName 

func (x *TagSpecifier) GetTagName() string

func (*TagSpecifier) GetTagValue 

func (m *TagSpecifier) GetTagValue() isTagSpecifier_TagValue

func (*TagSpecifier) ProtoMessage 

func (*TagSpecifier) ProtoMessage()

func (*TagSpecifier) ProtoReflect added in v0.9.6 

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

func (*TagSpecifier) Reset 

func (x *TagSpecifier) Reset()

func (*TagSpecifier) String 

func (x *TagSpecifier) String() string

func (*TagSpecifier) Validate 

func (m *TagSpecifier) Validate() error

Validate checks the field values on TagSpecifier 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 (*TagSpecifier) ValidateAll added in v0.10.0 

func (m *TagSpecifier) ValidateAll() error

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

type TagSpecifierMultiError added in v0.10.0 

type TagSpecifierMultiError []error

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

func (TagSpecifierMultiError) AllErrors added in v0.10.0 

func (m TagSpecifierMultiError) AllErrors() []error

AllErrors returns a list of validation violation errors.

func (TagSpecifierMultiError) Error added in v0.10.0 

func (m TagSpecifierMultiError) Error() string

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

type TagSpecifierValidationError 

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

TagSpecifierValidationError is the validation error returned by TagSpecifier.Validate if the designated constraints aren't met.

func (TagSpecifierValidationError) Cause 

func (e TagSpecifierValidationError) Cause() error

Cause function returns cause value.

func (TagSpecifierValidationError) Error 

func (e TagSpecifierValidationError) Error() string

Error satisfies the builtin error interface

func (TagSpecifierValidationError) ErrorName added in v0.7.0 

func (e TagSpecifierValidationError) ErrorName() string

ErrorName returns error name.

func (TagSpecifierValidationError) Field 

func (e TagSpecifierValidationError) Field() string

Field function returns field value.

func (TagSpecifierValidationError) Key 

func (e TagSpecifierValidationError) Key() bool

Key function returns key value.

func (TagSpecifierValidationError) Reason 

func (e TagSpecifierValidationError) Reason() string

Reason function returns reason value.

type TagSpecifier_FixedValue 

type TagSpecifier_FixedValue struct {
	// Specifies a fixed tag value for the “tag_name“.
	FixedValue string `protobuf:"bytes,3,opt,name=fixed_value,json=fixedValue,proto3,oneof"`
}

type TagSpecifier_Regex 

type TagSpecifier_Regex struct {
	// Designates a tag to strip from the tag extracted name and provide as a named
	// tag value for all statistics. This will only occur if any part of the name
	// matches the regex provided with one or more capture groups.
	//
	// The first capture group identifies the portion of the name to remove. The
	// second capture group (which will normally be nested inside the first) will
	// designate the value of the tag for the statistic. If no second capture
	// group is provided, the first will also be used to set the value of the tag.
	// All other capture groups will be ignored.
	//
	// Example 1. a stat name “cluster.foo_cluster.upstream_rq_timeout“ and
	// one tag specifier:
	//
	// .. code-block:: json
	//
	//	{
	//	  "tag_name": "envoy.cluster_name",
	//	  "regex": "^cluster\\.((.+?)\\.)"
	//	}
	//
	// Note that the regex will remove “foo_cluster.“ making the tag extracted
	// name “cluster.upstream_rq_timeout“ and the tag value for
	// “envoy.cluster_name“ will be “foo_cluster“ (note: there will be no
	// “.“ character because of the second capture group).
	//
	// Example 2. a stat name
	// “http.connection_manager_1.user_agent.ios.downstream_cx_total“ and two
	// tag specifiers:
	//
	// .. code-block:: json
	//
	//	[
	//	  {
	//	    "tag_name": "envoy.http_user_agent",
	//	    "regex": "^http(?=\\.).*?\\.user_agent\\.((.+?)\\.)\\w+?$"
	//	  },
	//	  {
	//	    "tag_name": "envoy.http_conn_manager_prefix",
	//	    "regex": "^http\\.((.*?)\\.)"
	//	  }
	//	]
	//
	// The two regexes of the specifiers will be processed in the definition order.
	//
	// The first regex will remove “ios.“, leaving the tag extracted name
	// “http.connection_manager_1.user_agent.downstream_cx_total“. The tag
	// “envoy.http_user_agent“ will be added with tag value “ios“.
	//
	// The second regex will remove “connection_manager_1.“ from the tag
	// extracted name produced by the first regex
	// “http.connection_manager_1.user_agent.downstream_cx_total“, leaving
	// “http.user_agent.downstream_cx_total“ as the tag extracted name. The tag
	// “envoy.http_conn_manager_prefix“ will be added with the tag value
	// “connection_manager_1“.
	Regex string `protobuf:"bytes,2,opt,name=regex,proto3,oneof"`
}

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.