metricsv2

package
v1.36.2-20240604200932... Latest Latest
Warning

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

 Go to latest Published: unknown License: Apache-2.0 Imports: 10 Imported by: 0

Documentation

Index

Constants

View Source 
const DogStatsdSink_Address_case case_DogStatsdSink_DogStatsdSpecifier = 1
View Source 
const DogStatsdSink_DogStatsdSpecifier_not_set_case case_DogStatsdSink_DogStatsdSpecifier = 0
View Source 
const StatsMatcher_ExclusionList_case case_StatsMatcher_StatsMatcher = 2
View Source 
const StatsMatcher_InclusionList_case case_StatsMatcher_StatsMatcher = 3
View Source 
const StatsMatcher_RejectAll_case case_StatsMatcher_StatsMatcher = 1
View Source 
const StatsMatcher_StatsMatcher_not_set_case case_StatsMatcher_StatsMatcher = 0
View Source 
const StatsSink_ConfigType_not_set_case case_StatsSink_ConfigType = 0
View Source 
const StatsSink_Config_case case_StatsSink_ConfigType = 2
View Source 
const StatsSink_TypedConfig_case case_StatsSink_ConfigType = 3
View Source 
const StatsdSink_Address_case case_StatsdSink_StatsdSpecifier = 1
View Source 
const StatsdSink_StatsdSpecifier_not_set_case case_StatsdSink_StatsdSpecifier = 0
View Source 
const StatsdSink_TcpClusterName_case case_StatsdSink_StatsdSpecifier = 2
View Source 
const TagSpecifier_FixedValue_case case_TagSpecifier_TagValue = 3
View Source 
const TagSpecifier_Regex_case case_TagSpecifier_TagValue = 2
View Source 
const TagSpecifier_TagValue_not_set_case case_TagSpecifier_TagValue = 0

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 valid to be assigned 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) ClearAddress 

func (x *DogStatsdSink) ClearAddress()

func (*DogStatsdSink) ClearDogStatsdSpecifier 

func (x *DogStatsdSink) ClearDogStatsdSpecifier()

func (*DogStatsdSink) GetAddress 

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

func (*DogStatsdSink) GetDogStatsdSpecifier 

func (x *DogStatsdSink) GetDogStatsdSpecifier() isDogStatsdSink_DogStatsdSpecifier

func (*DogStatsdSink) GetPrefix 

func (x *DogStatsdSink) GetPrefix() string

func (*DogStatsdSink) HasAddress 

func (x *DogStatsdSink) HasAddress() bool

func (*DogStatsdSink) HasDogStatsdSpecifier 

func (x *DogStatsdSink) HasDogStatsdSpecifier() bool

func (*DogStatsdSink) ProtoMessage 

func (*DogStatsdSink) ProtoMessage()

func (*DogStatsdSink) ProtoReflect 

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

func (*DogStatsdSink) Reset 

func (x *DogStatsdSink) Reset()

func (*DogStatsdSink) SetAddress 

func (x *DogStatsdSink) SetAddress(v *core.Address)

func (*DogStatsdSink) SetPrefix 

func (x *DogStatsdSink) SetPrefix(v string)

func (*DogStatsdSink) String 

func (x *DogStatsdSink) String() string

func (*DogStatsdSink) WhichDogStatsdSpecifier 

func (x *DogStatsdSink) WhichDogStatsdSpecifier() case_DogStatsdSink_DogStatsdSpecifier

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 DogStatsdSink_builder 

type DogStatsdSink_builder struct {

	// Fields of oneof DogStatsdSpecifier:
	// The UDP address of a running DogStatsD compliant listener. If specified,
	// statistics will be flushed to this address.
	Address *core.Address
	// -- end of DogStatsdSpecifier
	// Optional custom metric name prefix. See :ref:`StatsdSink's prefix field
	// <envoy_api_field_config.metrics.v2.StatsdSink.prefix>` for more details.
	Prefix string
	// contains filtered or unexported fields
}

func (DogStatsdSink_builder) Build 

func (b0 DogStatsdSink_builder) Build() *DogStatsdSink

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) GetNumBuckets 

func (x *HystrixSink) GetNumBuckets() int64

func (*HystrixSink) ProtoMessage 

func (*HystrixSink) ProtoMessage()

func (*HystrixSink) ProtoReflect 

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

func (*HystrixSink) Reset 

func (x *HystrixSink) Reset()

func (*HystrixSink) SetNumBuckets 

func (x *HystrixSink) SetNumBuckets(v int64)

func (*HystrixSink) String 

func (x *HystrixSink) String() string

type HystrixSink_builder 

type HystrixSink_builder 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
	// contains filtered or unexported fields
}

func (HystrixSink_builder) Build 

func (b0 HystrixSink_builder) Build() *HystrixSink

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) ClearGrpcService 

func (x *MetricsServiceConfig) ClearGrpcService()

func (*MetricsServiceConfig) GetGrpcService 

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

func (*MetricsServiceConfig) HasGrpcService 

func (x *MetricsServiceConfig) HasGrpcService() bool

func (*MetricsServiceConfig) ProtoMessage 

func (*MetricsServiceConfig) ProtoMessage()

func (*MetricsServiceConfig) ProtoReflect 

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

func (*MetricsServiceConfig) Reset 

func (x *MetricsServiceConfig) Reset()

func (*MetricsServiceConfig) SetGrpcService 

func (x *MetricsServiceConfig) SetGrpcService(v *core.GrpcService)

func (*MetricsServiceConfig) String 

func (x *MetricsServiceConfig) String() string

type MetricsServiceConfig_builder 

type MetricsServiceConfig_builder struct {

	// The upstream gRPC cluster that hosts the metrics service.
	GrpcService *core.GrpcService
	// contains filtered or unexported fields
}

func (MetricsServiceConfig_builder) Build 

func (b0 MetricsServiceConfig_builder) Build() *MetricsServiceConfig

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) ClearStatsMatcher 

func (x *StatsConfig) ClearStatsMatcher()

func (*StatsConfig) ClearUseAllDefaultTags 

func (x *StatsConfig) ClearUseAllDefaultTags()

func (*StatsConfig) GetStatsMatcher 

func (x *StatsConfig) GetStatsMatcher() *StatsMatcher

func (*StatsConfig) GetStatsTags 

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

func (*StatsConfig) GetUseAllDefaultTags 

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

func (*StatsConfig) HasStatsMatcher 

func (x *StatsConfig) HasStatsMatcher() bool

func (*StatsConfig) HasUseAllDefaultTags 

func (x *StatsConfig) HasUseAllDefaultTags() bool

func (*StatsConfig) ProtoMessage 

func (*StatsConfig) ProtoMessage()

func (*StatsConfig) ProtoReflect 

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

func (*StatsConfig) Reset 

func (x *StatsConfig) Reset()

func (*StatsConfig) SetStatsMatcher 

func (x *StatsConfig) SetStatsMatcher(v *StatsMatcher)

func (*StatsConfig) SetStatsTags 

func (x *StatsConfig) SetStatsTags(v []*TagSpecifier)

func (*StatsConfig) SetUseAllDefaultTags 

func (x *StatsConfig) SetUseAllDefaultTags(v *wrapperspb.BoolValue)

func (*StatsConfig) String 

func (x *StatsConfig) String() string

type StatsConfig_builder 

type StatsConfig_builder 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
	// 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
	// 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
	// contains filtered or unexported fields
}

func (StatsConfig_builder) Build 

func (b0 StatsConfig_builder) Build() *StatsConfig

type StatsMatcher 

type StatsMatcher struct {

	// Types that are valid to be assigned 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) ClearExclusionList 

func (x *StatsMatcher) ClearExclusionList()

func (*StatsMatcher) ClearInclusionList 

func (x *StatsMatcher) ClearInclusionList()

func (*StatsMatcher) ClearRejectAll 

func (x *StatsMatcher) ClearRejectAll()

func (*StatsMatcher) ClearStatsMatcher 

func (x *StatsMatcher) ClearStatsMatcher()

func (*StatsMatcher) GetExclusionList 

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

func (*StatsMatcher) GetInclusionList 

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

func (*StatsMatcher) GetRejectAll 

func (x *StatsMatcher) GetRejectAll() bool

func (*StatsMatcher) GetStatsMatcher 

func (x *StatsMatcher) GetStatsMatcher() isStatsMatcher_StatsMatcher

func (*StatsMatcher) HasExclusionList 

func (x *StatsMatcher) HasExclusionList() bool

func (*StatsMatcher) HasInclusionList 

func (x *StatsMatcher) HasInclusionList() bool

func (*StatsMatcher) HasRejectAll 

func (x *StatsMatcher) HasRejectAll() bool

func (*StatsMatcher) HasStatsMatcher 

func (x *StatsMatcher) HasStatsMatcher() bool

func (*StatsMatcher) ProtoMessage 

func (*StatsMatcher) ProtoMessage()

func (*StatsMatcher) ProtoReflect 

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

func (*StatsMatcher) Reset 

func (x *StatsMatcher) Reset()

func (*StatsMatcher) SetExclusionList 

func (x *StatsMatcher) SetExclusionList(v *matcher.ListStringMatcher)

func (*StatsMatcher) SetInclusionList 

func (x *StatsMatcher) SetInclusionList(v *matcher.ListStringMatcher)

func (*StatsMatcher) SetRejectAll 

func (x *StatsMatcher) SetRejectAll(v bool)

func (*StatsMatcher) String 

func (x *StatsMatcher) String() string

func (*StatsMatcher) WhichStatsMatcher 

func (x *StatsMatcher) WhichStatsMatcher() case_StatsMatcher_StatsMatcher

type StatsMatcher_ExclusionList 

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 

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 

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 StatsMatcher_builder 

type StatsMatcher_builder struct {

	// Fields of oneof StatsMatcher:
	// If `reject_all` is true, then all stats are disabled. If `reject_all` is false, then all
	// stats are enabled.
	RejectAll *bool
	// Exclusive match. All stats are enabled except for those matching one of the supplied
	// StringMatcher protos.
	ExclusionList *matcher.ListStringMatcher
	// Inclusive match. No stats are enabled except for those matching one of the supplied
	// StringMatcher protos.
	InclusionList *matcher.ListStringMatcher
	// contains filtered or unexported fields
}

func (StatsMatcher_builder) Build 

func (b0 StatsMatcher_builder) Build() *StatsMatcher

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 valid to be assigned 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) ClearConfig deprecated 

func (x *StatsSink) ClearConfig()

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

func (*StatsSink) ClearConfigType 

func (x *StatsSink) ClearConfigType()

func (*StatsSink) ClearTypedConfig 

func (x *StatsSink) ClearTypedConfig()

func (*StatsSink) GetConfig deprecated 

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

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

func (*StatsSink) GetConfigType 

func (x *StatsSink) GetConfigType() isStatsSink_ConfigType

func (*StatsSink) GetName 

func (x *StatsSink) GetName() string

func (*StatsSink) GetTypedConfig 

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

func (*StatsSink) HasConfig deprecated 

func (x *StatsSink) HasConfig() bool

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

func (*StatsSink) HasConfigType 

func (x *StatsSink) HasConfigType() bool

func (*StatsSink) HasTypedConfig 

func (x *StatsSink) HasTypedConfig() bool

func (*StatsSink) ProtoMessage 

func (*StatsSink) ProtoMessage()

func (*StatsSink) ProtoReflect 

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

func (*StatsSink) Reset 

func (x *StatsSink) Reset()

func (*StatsSink) SetConfig deprecated 

func (x *StatsSink) SetConfig(v *structpb.Struct)

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

func (*StatsSink) SetName 

func (x *StatsSink) SetName(v string)

func (*StatsSink) SetTypedConfig 

func (x *StatsSink) SetTypedConfig(v *anypb.Any)

func (*StatsSink) String 

func (x *StatsSink) String() string

func (*StatsSink) WhichConfigType 

func (x *StatsSink) WhichConfigType() case_StatsSink_ConfigType

type StatsSink_Config 

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 

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

type StatsSink_builder 

type StatsSink_builder 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

	// Fields of oneof ConfigType:
	// Deprecated: Marked as deprecated in envoy/config/metrics/v2/stats.proto.
	Config      *structpb.Struct
	TypedConfig *anypb.Any
	// contains filtered or unexported fields
}

func (StatsSink_builder) Build 

func (b0 StatsSink_builder) Build() *StatsSink

type StatsdSink 

type StatsdSink struct {

	// Types that are valid to be assigned 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) ClearAddress 

func (x *StatsdSink) ClearAddress()

func (*StatsdSink) ClearStatsdSpecifier 

func (x *StatsdSink) ClearStatsdSpecifier()

func (*StatsdSink) ClearTcpClusterName 

func (x *StatsdSink) ClearTcpClusterName()

func (*StatsdSink) GetAddress 

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

func (*StatsdSink) GetPrefix 

func (x *StatsdSink) GetPrefix() string

func (*StatsdSink) GetStatsdSpecifier 

func (x *StatsdSink) GetStatsdSpecifier() isStatsdSink_StatsdSpecifier

func (*StatsdSink) GetTcpClusterName 

func (x *StatsdSink) GetTcpClusterName() string

func (*StatsdSink) HasAddress 

func (x *StatsdSink) HasAddress() bool

func (*StatsdSink) HasStatsdSpecifier 

func (x *StatsdSink) HasStatsdSpecifier() bool

func (*StatsdSink) HasTcpClusterName 

func (x *StatsdSink) HasTcpClusterName() bool

func (*StatsdSink) ProtoMessage 

func (*StatsdSink) ProtoMessage()

func (*StatsdSink) ProtoReflect 

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

func (*StatsdSink) Reset 

func (x *StatsdSink) Reset()

func (*StatsdSink) SetAddress 

func (x *StatsdSink) SetAddress(v *core.Address)

func (*StatsdSink) SetPrefix 

func (x *StatsdSink) SetPrefix(v string)

func (*StatsdSink) SetTcpClusterName 

func (x *StatsdSink) SetTcpClusterName(v string)

func (*StatsdSink) String 

func (x *StatsdSink) String() string

func (*StatsdSink) WhichStatsdSpecifier 

func (x *StatsdSink) WhichStatsdSpecifier() case_StatsdSink_StatsdSpecifier

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 StatsdSink_builder 

type StatsdSink_builder struct {

	// Fields of oneof StatsdSpecifier:
	// 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
	// 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
	// -- end of StatsdSpecifier
	// 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
	// contains filtered or unexported fields
}

func (StatsdSink_builder) Build 

func (b0 StatsdSink_builder) Build() *StatsdSink

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 valid to be assigned 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) ClearFixedValue 

func (x *TagSpecifier) ClearFixedValue()

func (*TagSpecifier) ClearRegex 

func (x *TagSpecifier) ClearRegex()

func (*TagSpecifier) ClearTagValue 

func (x *TagSpecifier) ClearTagValue()

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 (x *TagSpecifier) GetTagValue() isTagSpecifier_TagValue

func (*TagSpecifier) HasFixedValue 

func (x *TagSpecifier) HasFixedValue() bool

func (*TagSpecifier) HasRegex 

func (x *TagSpecifier) HasRegex() bool

func (*TagSpecifier) HasTagValue 

func (x *TagSpecifier) HasTagValue() bool

func (*TagSpecifier) ProtoMessage 

func (*TagSpecifier) ProtoMessage()

func (*TagSpecifier) ProtoReflect 

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

func (*TagSpecifier) Reset 

func (x *TagSpecifier) Reset()

func (*TagSpecifier) SetFixedValue 

func (x *TagSpecifier) SetFixedValue(v string)

func (*TagSpecifier) SetRegex 

func (x *TagSpecifier) SetRegex(v string)

func (*TagSpecifier) SetTagName 

func (x *TagSpecifier) SetTagName(v string)

func (*TagSpecifier) String 

func (x *TagSpecifier) String() string

func (*TagSpecifier) WhichTagValue 

func (x *TagSpecifier) WhichTagValue() case_TagSpecifier_TagValue

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"`
}

type TagSpecifier_builder 

type TagSpecifier_builder 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
	// Fields of oneof TagValue:
	// 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
	// Specifies a fixed tag value for the “tag_name“.
	FixedValue *string
	// contains filtered or unexported fields
}

func (TagSpecifier_builder) Build 

func (b0 TagSpecifier_builder) Build() *TagSpecifier

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.