metricsv3

package
v0.0.0-...-c52558e Latest Latest
Warning

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

 Go to latest Published: Dec 3, 2024 License: Apache-2.0 Imports: 22 Imported by: 1

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var (
	HistogramEmitMode_name = map[int32]string{
		0: "SUMMARY_AND_HISTOGRAM",
		1: "SUMMARY",
		2: "HISTOGRAM",
	}
	HistogramEmitMode_value = map[string]int32{
		"SUMMARY_AND_HISTOGRAM": 0,
		"SUMMARY":               1,
		"HISTOGRAM":             2,
	}
)

Enum value maps for HistogramEmitMode.

View Source 
var File_envoy_config_metrics_v3_metrics_service_proto protoreflect.FileDescriptor
View Source 
var File_envoy_config_metrics_v3_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_v3_api_field_config.metrics.v3.StatsdSink.prefix>` for more details.
	Prefix string `protobuf:"bytes,3,opt,name=prefix,proto3" json:"prefix,omitempty"`
	// Optional max datagram size to use when sending UDP messages. By default Envoy
	// will emit one metric per datagram. By specifying a max-size larger than a single
	// metric, Envoy will emit multiple, new-line separated metrics. The max datagram
	// size should not exceed your network's MTU.
	//
	// Note that this value may not be respected if smaller than a single metric.
	MaxBytesPerDatagram *wrapperspb.UInt64Value `protobuf:"bytes,4,opt,name=max_bytes_per_datagram,json=maxBytesPerDatagram,proto3" json:"max_bytes_per_datagram,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_v3_api_msg_config.metrics.v3.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() *v31.Address

func (*DogStatsdSink) GetDogStatsdSpecifier 

func (m *DogStatsdSink) GetDogStatsdSpecifier() isDogStatsdSink_DogStatsdSpecifier

func (*DogStatsdSink) GetMaxBytesPerDatagram 

func (x *DogStatsdSink) GetMaxBytesPerDatagram() *wrapperspb.UInt64Value

func (*DogStatsdSink) GetPrefix 

func (x *DogStatsdSink) GetPrefix() string

func (*DogStatsdSink) ProtoMessage 

func (*DogStatsdSink) ProtoMessage()

func (*DogStatsdSink) ProtoReflect 

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 

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 

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 

func (m DogStatsdSinkMultiError) AllErrors() []error

AllErrors returns a list of validation violation errors.

func (DogStatsdSinkMultiError) Error 

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 

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 *v31.Address `protobuf:"bytes,1,opt,name=address,proto3,oneof"`
}

type HistogramBucketSettings 

type HistogramBucketSettings struct {

	// The stats that this rule applies to. The match is applied to the original stat name
	// before tag-extraction, for example “cluster.exampleclustername.upstream_cx_length_ms“.
	Match *v3.StringMatcher `protobuf:"bytes,1,opt,name=match,proto3" json:"match,omitempty"`
	// Each value is the upper bound of a bucket. Each bucket must be greater than 0 and unique.
	// The order of the buckets does not matter.
	Buckets []float64 `protobuf:"fixed64,2,rep,packed,name=buckets,proto3" json:"buckets,omitempty"`
	// contains filtered or unexported fields
}

Specifies a matcher for stats and the buckets that matching stats should use.

func (*HistogramBucketSettings) Descriptor deprecated 

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

Deprecated: Use HistogramBucketSettings.ProtoReflect.Descriptor instead.

func (*HistogramBucketSettings) GetBuckets 

func (x *HistogramBucketSettings) GetBuckets() []float64

func (*HistogramBucketSettings) GetMatch 

func (x *HistogramBucketSettings) GetMatch() *v3.StringMatcher

func (*HistogramBucketSettings) ProtoMessage 

func (*HistogramBucketSettings) ProtoMessage()

func (*HistogramBucketSettings) ProtoReflect 

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

func (*HistogramBucketSettings) Reset 

func (x *HistogramBucketSettings) Reset()

func (*HistogramBucketSettings) String 

func (x *HistogramBucketSettings) String() string

func (*HistogramBucketSettings) Validate 

func (m *HistogramBucketSettings) Validate() error

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

func (m *HistogramBucketSettings) ValidateAll() error

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

type HistogramBucketSettingsMultiError 

type HistogramBucketSettingsMultiError []error

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

func (HistogramBucketSettingsMultiError) AllErrors 

func (m HistogramBucketSettingsMultiError) AllErrors() []error

AllErrors returns a list of validation violation errors.

func (HistogramBucketSettingsMultiError) Error 

func (m HistogramBucketSettingsMultiError) Error() string

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

type HistogramBucketSettingsValidationError 

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

HistogramBucketSettingsValidationError is the validation error returned by HistogramBucketSettings.Validate if the designated constraints aren't met.

func (HistogramBucketSettingsValidationError) Cause 

func (e HistogramBucketSettingsValidationError) Cause() error

Cause function returns cause value.

func (HistogramBucketSettingsValidationError) Error 

func (e HistogramBucketSettingsValidationError) Error() string

Error satisfies the builtin error interface

func (HistogramBucketSettingsValidationError) ErrorName 

func (e HistogramBucketSettingsValidationError) ErrorName() string

ErrorName returns error name.

func (HistogramBucketSettingsValidationError) Field 

func (e HistogramBucketSettingsValidationError) Field() string

Field function returns field value.

func (HistogramBucketSettingsValidationError) Key 

func (e HistogramBucketSettingsValidationError) Key() bool

Key function returns key value.

func (HistogramBucketSettingsValidationError) Reason 

func (e HistogramBucketSettingsValidationError) Reason() string

Reason function returns reason value.

type HistogramEmitMode 

type HistogramEmitMode int32

HistogramEmitMode is used to configure which metric types should be emitted for histograms. 

const (
	// Emit Histogram and Summary metric types.
	HistogramEmitMode_SUMMARY_AND_HISTOGRAM HistogramEmitMode = 0
	// Emit only Summary metric types.
	HistogramEmitMode_SUMMARY HistogramEmitMode = 1
	// Emit only Histogram metric types.
	HistogramEmitMode_HISTOGRAM HistogramEmitMode = 2
)

func (HistogramEmitMode) Descriptor 

func (HistogramEmitMode) Descriptor() protoreflect.EnumDescriptor

func (HistogramEmitMode) Enum 

func (x HistogramEmitMode) Enum() *HistogramEmitMode

func (HistogramEmitMode) EnumDescriptor deprecated 

func (HistogramEmitMode) EnumDescriptor() ([]byte, []int)

Deprecated: Use HistogramEmitMode.Descriptor instead.

func (HistogramEmitMode) Number 

func (x HistogramEmitMode) Number() protoreflect.EnumNumber

func (HistogramEmitMode) String 

func (x HistogramEmitMode) String() string

func (HistogramEmitMode) Type 

func (HistogramEmitMode) Type() protoreflect.EnumType

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 

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 

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 

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 

func (m HystrixSinkMultiError) AllErrors() []error

AllErrors returns a list of validation violation errors.

func (HystrixSinkMultiError) Error 

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 

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 *v3.GrpcService `protobuf:"bytes,1,opt,name=grpc_service,json=grpcService,proto3" json:"grpc_service,omitempty"`
	// API version for metric service transport protocol. This describes the metric service gRPC
	// endpoint and version of messages used on the wire.
	TransportApiVersion v3.ApiVersion `` /* 158-byte string literal not displayed */
	// If true, counters are reported as the delta between flushing intervals. Otherwise, the current
	// counter value is reported. Defaults to false.
	// Eventually (https://github.com/envoyproxy/envoy/issues/10968) if this value is not set, the
	// sink will take updates from the :ref:`MetricsResponse <envoy_v3_api_msg_service.metrics.v3.StreamMetricsResponse>`.
	ReportCountersAsDeltas *wrapperspb.BoolValue `` /* 131-byte string literal not displayed */
	// If true, metrics will have their tags emitted as labels on the metrics objects sent to the MetricsService,
	// and the tag extracted name will be used instead of the full name, which may contain values used by the tag
	// extractor or additional tags added during stats creation.
	EmitTagsAsLabels bool `protobuf:"varint,4,opt,name=emit_tags_as_labels,json=emitTagsAsLabels,proto3" json:"emit_tags_as_labels,omitempty"`
	// Specify which metrics types to emit for histograms. Defaults to SUMMARY_AND_HISTOGRAM.
	HistogramEmitMode HistogramEmitMode `` /* 162-byte string literal not displayed */
	// contains filtered or unexported fields
}

Metrics Service is configured as a built-in “envoy.stat_sinks.metrics_service“ :ref:`StatsSink <envoy_v3_api_msg_config.metrics.v3.StatsSink>`. This opaque configuration will be used to create Metrics Service.

Example:

.. code-block:: yaml 

stats_sinks:
  - name: envoy.stat_sinks.metrics_service
    typed_config:
      "@type": type.googleapis.com/envoy.config.metrics.v3.MetricsServiceConfig

[#extension: envoy.stat_sinks.metrics_service] [#next-free-field: 6]

func (*MetricsServiceConfig) Descriptor deprecated 

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

Deprecated: Use MetricsServiceConfig.ProtoReflect.Descriptor instead.

func (*MetricsServiceConfig) GetEmitTagsAsLabels 

func (x *MetricsServiceConfig) GetEmitTagsAsLabels() bool

func (*MetricsServiceConfig) GetGrpcService 

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

func (*MetricsServiceConfig) GetHistogramEmitMode 

func (x *MetricsServiceConfig) GetHistogramEmitMode() HistogramEmitMode

func (*MetricsServiceConfig) GetReportCountersAsDeltas 

func (x *MetricsServiceConfig) GetReportCountersAsDeltas() *wrapperspb.BoolValue

func (*MetricsServiceConfig) GetTransportApiVersion 

func (x *MetricsServiceConfig) GetTransportApiVersion() v3.ApiVersion

func (*MetricsServiceConfig) ProtoMessage 

func (*MetricsServiceConfig) ProtoMessage()

func (*MetricsServiceConfig) ProtoReflect 

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 

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 

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 

func (m MetricsServiceConfigMultiError) AllErrors() []error

AllErrors returns a list of validation violation errors.

func (MetricsServiceConfigMultiError) Error 

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 

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 independently processed through these tag specifiers. When a tag is
	// matched, the first capture group is not immediately removed from the name, so later
	// :ref:`TagSpecifiers <envoy_v3_api_msg_config.metrics.v3.TagSpecifier>` can also match that
	// same portion of the match. After all tag matching is complete, a tag-extracted version of
	// the name is produced and is used in stats sinks that represent tags, such as Prometheus.
	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_v3_api_field_config.metrics.v3.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"`
	// Defines rules for setting the histogram buckets. Rules are evaluated in order, and the first
	// match is applied. If no match is found (or if no rules are set), the following default buckets
	// are used:
	//
	//	.. code-block:: json
	//
	//	  [
	//	    0.5,
	//	    1,
	//	    5,
	//	    10,
	//	    25,
	//	    50,
	//	    100,
	//	    250,
	//	    500,
	//	    1000,
	//	    2500,
	//	    5000,
	//	    10000,
	//	    30000,
	//	    60000,
	//	    300000,
	//	    600000,
	//	    1800000,
	//	    3600000
	//	  ]
	HistogramBucketSettings []*HistogramBucketSettings `` /* 132-byte string literal not displayed */
	// 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) GetHistogramBucketSettings 

func (x *StatsConfig) GetHistogramBucketSettings() []*HistogramBucketSettings

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

func (*StatsConfig) ProtoMessage()

func (*StatsConfig) ProtoReflect 

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 

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 

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 

func (m StatsConfigMultiError) AllErrors() []error

AllErrors returns a list of validation violation errors.

func (StatsConfigMultiError) Error 

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 

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 

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 

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

Deprecated: Use StatsMatcher.ProtoReflect.Descriptor instead.

func (*StatsMatcher) GetExclusionList 

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

func (*StatsMatcher) GetInclusionList 

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

func (*StatsMatcher) GetRejectAll 

func (x *StatsMatcher) GetRejectAll() bool

func (*StatsMatcher) GetStatsMatcher 

func (m *StatsMatcher) GetStatsMatcher() isStatsMatcher_StatsMatcher

func (*StatsMatcher) ProtoMessage 

func (*StatsMatcher) ProtoMessage()

func (*StatsMatcher) ProtoReflect 

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

func (*StatsMatcher) Reset 

func (x *StatsMatcher) Reset()

func (*StatsMatcher) String 

func (x *StatsMatcher) String() string

func (*StatsMatcher) Validate 

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 

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 

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 

func (m StatsMatcherMultiError) AllErrors() []error

AllErrors returns a list of validation violation errors.

func (StatsMatcherMultiError) Error 

func (m StatsMatcherMultiError) Error() string

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

type StatsMatcherValidationError 

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 

func (e StatsMatcherValidationError) Cause() error

Cause function returns cause value.

func (StatsMatcherValidationError) Error 

func (e StatsMatcherValidationError) Error() string

Error satisfies the builtin error interface

func (StatsMatcherValidationError) ErrorName 

func (e StatsMatcherValidationError) ErrorName() string

ErrorName returns error name.

func (StatsMatcherValidationError) Field 

func (e StatsMatcherValidationError) Field() string

Field function returns field value.

func (StatsMatcherValidationError) Key 

func (e StatsMatcherValidationError) Key() bool

Key function returns key value.

func (StatsMatcherValidationError) Reason 

func (e StatsMatcherValidationError) Reason() string

Reason function returns reason value.

type StatsMatcher_ExclusionList 

type StatsMatcher_ExclusionList struct {
	// Exclusive match. All stats are enabled except for those matching one of the supplied
	// StringMatcher protos.
	ExclusionList *v3.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 *v3.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 StatsSink 

type StatsSink struct {

	// The name of the stats sink to instantiate. The name must match a supported
	// stats sink.
	// See the :ref:`extensions listed in typed_config below <extension_category_envoy.stats_sinks>` for the default list of available stats sink.
	// 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_v3_api_msg_config.metrics.v3.StatsdSink>` for an example.
	// [#extension-category: envoy.stats_sinks]
	//
	// Types that are assignable to ConfigType:
	//
	//	*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) GetConfigType 

func (m *StatsSink) GetConfigType() isStatsSink_ConfigType

func (*StatsSink) GetName 

func (x *StatsSink) GetName() string

func (*StatsSink) GetTypedConfig 

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

func (*StatsSink) ProtoMessage 

func (*StatsSink) ProtoMessage()

func (*StatsSink) ProtoReflect 

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 

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 

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 

func (m StatsSinkMultiError) AllErrors() []error

AllErrors returns a list of validation violation errors.

func (StatsSinkMultiError) Error 

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 

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_TypedConfig 

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() *v31.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 

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 

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 

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 

func (m StatsdSinkMultiError) AllErrors() []error

AllErrors returns a list of validation violation errors.

func (StatsdSinkMultiError) Error 

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 

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 *v31.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_v3_api_field_config.metrics.v3.TagSpecifier.tag_name>` is provided in the config and
	// neither :ref:`regex <envoy_v3_api_field_config.metrics.v3.TagSpecifier.regex>` or
	// :ref:`fixed_value <envoy_v3_api_field_config.metrics.v3.TagSpecifier.fixed_value>` were specified,
	// Envoy will attempt to find that name in its set of defaults and use the accompanying regex.
	//
	// .. note::
	//
	//	A stat name may be spelled in such a way that it matches two different
	//	tag extractors for the same tag name. In that case, all but one of the
	//	tag values will be dropped. It is not specified which tag value will be
	//	retained. The extraction will only occur for one of the extractors, and
	//	only the matched extraction will be removed from the tag name.
	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 

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 

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 

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 

func (m TagSpecifierMultiError) AllErrors() []error

AllErrors returns a list of validation violation errors.

func (TagSpecifierMultiError) Error 

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 

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 from the elaborated
	// stat name.
	//
	// The first regex will save “ios.“ as the tag value for “envoy.http_user_agent“. It will
	// leave it in the name for potential matching with additional tag specifiers. After all tag
	// specifiers are processed the tags will be removed from the name.
	//
	// The second regex will populate tag “envoy.http_conn_manager_prefix“ with value
	// “connection_manager_1.“, based on the original stat name.
	//
	// As a final step, the matched tags are removed, leaving
	// “http.user_agent.downstream_cx_total“ as the tag extracted name.
	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.