envoy_config_metrics_v2

package
v1.12.1 Latest Latest
Warning

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

 Go to latest Published: Mar 30, 2020 License: Apache-2.0 Imports: 7 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

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"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

Stats configuration proto schema for built-in *envoy.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>`.

func (*DogStatsdSink) Descriptor 

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

func (*DogStatsdSink) GetAddress 

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

func (*DogStatsdSink) GetDogStatsdSpecifier 

func (m *DogStatsdSink) GetDogStatsdSpecifier() isDogStatsdSink_DogStatsdSpecifier

func (*DogStatsdSink) GetPrefix 

func (m *DogStatsdSink) GetPrefix() string

func (*DogStatsdSink) ProtoMessage 

func (*DogStatsdSink) ProtoMessage()

func (*DogStatsdSink) Reset 

func (m *DogStatsdSink) Reset()

func (*DogStatsdSink) String 

func (m *DogStatsdSink) String() string

func (*DogStatsdSink) XXX_DiscardUnknown 

func (m *DogStatsdSink) XXX_DiscardUnknown()

func (*DogStatsdSink) XXX_Marshal 

func (m *DogStatsdSink) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*DogStatsdSink) XXX_Merge 

func (m *DogStatsdSink) XXX_Merge(src proto.Message)

func (*DogStatsdSink) XXX_OneofWrappers 

func (*DogStatsdSink) XXX_OneofWrappers() []interface{}

XXX_OneofWrappers is for the internal use of the proto package.

func (*DogStatsdSink) XXX_Size 

func (m *DogStatsdSink) XXX_Size() int

func (*DogStatsdSink) XXX_Unmarshal 

func (m *DogStatsdSink) XXX_Unmarshal(b []byte) error

type DogStatsdSink_Address 

type DogStatsdSink_Address struct {
	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"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

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`.

func (*HystrixSink) Descriptor 

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

func (*HystrixSink) GetNumBuckets 

func (m *HystrixSink) GetNumBuckets() int64

func (*HystrixSink) ProtoMessage 

func (*HystrixSink) ProtoMessage()

func (*HystrixSink) Reset 

func (m *HystrixSink) Reset()

func (*HystrixSink) String 

func (m *HystrixSink) String() string

func (*HystrixSink) XXX_DiscardUnknown 

func (m *HystrixSink) XXX_DiscardUnknown()

func (*HystrixSink) XXX_Marshal 

func (m *HystrixSink) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*HystrixSink) XXX_Merge 

func (m *HystrixSink) XXX_Merge(src proto.Message)

func (*HystrixSink) XXX_Size 

func (m *HystrixSink) XXX_Size() int

func (*HystrixSink) XXX_Unmarshal 

func (m *HystrixSink) XXX_Unmarshal(b []byte) error

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"`
	XXX_NoUnkeyedLiteral struct{}          `json:"-"`
	XXX_unrecognized     []byte            `json:"-"`
	XXX_sizecache        int32             `json:"-"`
}

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

func (*MetricsServiceConfig) Descriptor 

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

func (*MetricsServiceConfig) GetGrpcService 

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

func (*MetricsServiceConfig) ProtoMessage 

func (*MetricsServiceConfig) ProtoMessage()

func (*MetricsServiceConfig) Reset 

func (m *MetricsServiceConfig) Reset()

func (*MetricsServiceConfig) String 

func (m *MetricsServiceConfig) String() string

func (*MetricsServiceConfig) XXX_DiscardUnknown 

func (m *MetricsServiceConfig) XXX_DiscardUnknown()

func (*MetricsServiceConfig) XXX_Marshal 

func (m *MetricsServiceConfig) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*MetricsServiceConfig) XXX_Merge 

func (m *MetricsServiceConfig) XXX_Merge(src proto.Message)

func (*MetricsServiceConfig) XXX_Size 

func (m *MetricsServiceConfig) XXX_Size() int

func (*MetricsServiceConfig) XXX_Unmarshal 

func (m *MetricsServiceConfig) XXX_Unmarshal(b []byte) error

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 *types.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.
	StatsMatcher         *StatsMatcher `protobuf:"bytes,3,opt,name=stats_matcher,json=statsMatcher,proto3" json:"stats_matcher,omitempty"`
	XXX_NoUnkeyedLiteral struct{}      `json:"-"`
	XXX_unrecognized     []byte        `json:"-"`
	XXX_sizecache        int32         `json:"-"`
}

Statistics configuration such as tagging.

func (*StatsConfig) Descriptor 

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

func (*StatsConfig) GetStatsMatcher 

func (m *StatsConfig) GetStatsMatcher() *StatsMatcher

func (*StatsConfig) GetStatsTags 

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

func (*StatsConfig) GetUseAllDefaultTags 

func (m *StatsConfig) GetUseAllDefaultTags() *types.BoolValue

func (*StatsConfig) ProtoMessage 

func (*StatsConfig) ProtoMessage()

func (*StatsConfig) Reset 

func (m *StatsConfig) Reset()

func (*StatsConfig) String 

func (m *StatsConfig) String() string

func (*StatsConfig) XXX_DiscardUnknown 

func (m *StatsConfig) XXX_DiscardUnknown()

func (*StatsConfig) XXX_Marshal 

func (m *StatsConfig) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*StatsConfig) XXX_Merge 

func (m *StatsConfig) XXX_Merge(src proto.Message)

func (*StatsConfig) XXX_Size 

func (m *StatsConfig) XXX_Size() int

func (*StatsConfig) XXX_Unmarshal 

func (m *StatsConfig) XXX_Unmarshal(b []byte) error

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"`
	XXX_NoUnkeyedLiteral struct{}                    `json:"-"`
	XXX_unrecognized     []byte                      `json:"-"`
	XXX_sizecache        int32                       `json:"-"`
}

Configuration for disabling stat instantiation.

func (*StatsMatcher) Descriptor 

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

func (*StatsMatcher) GetExclusionList 

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

func (*StatsMatcher) GetInclusionList 

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

func (*StatsMatcher) GetRejectAll 

func (m *StatsMatcher) GetRejectAll() bool

func (*StatsMatcher) GetStatsMatcher 

func (m *StatsMatcher) GetStatsMatcher() isStatsMatcher_StatsMatcher

func (*StatsMatcher) ProtoMessage 

func (*StatsMatcher) ProtoMessage()

func (*StatsMatcher) Reset 

func (m *StatsMatcher) Reset()

func (*StatsMatcher) String 

func (m *StatsMatcher) String() string

func (*StatsMatcher) XXX_DiscardUnknown 

func (m *StatsMatcher) XXX_DiscardUnknown()

func (*StatsMatcher) XXX_Marshal 

func (m *StatsMatcher) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*StatsMatcher) XXX_Merge 

func (m *StatsMatcher) XXX_Merge(src proto.Message)

func (*StatsMatcher) XXX_OneofWrappers 

func (*StatsMatcher) XXX_OneofWrappers() []interface{}

XXX_OneofWrappers is for the internal use of the proto package.

func (*StatsMatcher) XXX_Size 

func (m *StatsMatcher) XXX_Size() int

func (*StatsMatcher) XXX_Unmarshal 

func (m *StatsMatcher) XXX_Unmarshal(b []byte) error

type StatsMatcher_ExclusionList 

type StatsMatcher_ExclusionList struct {
	ExclusionList *matcher.ListStringMatcher `protobuf:"bytes,2,opt,name=exclusion_list,json=exclusionList,proto3,oneof"`
}

type StatsMatcher_InclusionList 

type StatsMatcher_InclusionList struct {
	InclusionList *matcher.ListStringMatcher `protobuf:"bytes,3,opt,name=inclusion_list,json=inclusionList,proto3,oneof"`
}

type StatsMatcher_RejectAll 

type StatsMatcher_RejectAll struct {
	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.statsd <envoy_api_msg_config.metrics.v2.StatsdSink>`
	// * :ref:`envoy.dog_statsd <envoy_api_msg_config.metrics.v2.DogStatsdSink>`
	// * :ref:`envoy.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"`
	XXX_NoUnkeyedLiteral struct{}               `json:"-"`
	XXX_unrecognized     []byte                 `json:"-"`
	XXX_sizecache        int32                  `json:"-"`
}

Configuration for pluggable stats sinks.

func (*StatsSink) Descriptor 

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

func (*StatsSink) GetConfig deprecated 

func (m *StatsSink) GetConfig() *types.Struct

Deprecated: Do not use.

func (*StatsSink) GetConfigType 

func (m *StatsSink) GetConfigType() isStatsSink_ConfigType

func (*StatsSink) GetName 

func (m *StatsSink) GetName() string

func (*StatsSink) GetTypedConfig 

func (m *StatsSink) GetTypedConfig() *types.Any

func (*StatsSink) ProtoMessage 

func (*StatsSink) ProtoMessage()

func (*StatsSink) Reset 

func (m *StatsSink) Reset()

func (*StatsSink) String 

func (m *StatsSink) String() string

func (*StatsSink) XXX_DiscardUnknown 

func (m *StatsSink) XXX_DiscardUnknown()

func (*StatsSink) XXX_Marshal 

func (m *StatsSink) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*StatsSink) XXX_Merge 

func (m *StatsSink) XXX_Merge(src proto.Message)

func (*StatsSink) XXX_OneofWrappers 

func (*StatsSink) XXX_OneofWrappers() []interface{}

XXX_OneofWrappers is for the internal use of the proto package.

func (*StatsSink) XXX_Size 

func (m *StatsSink) XXX_Size() int

func (*StatsSink) XXX_Unmarshal 

func (m *StatsSink) XXX_Unmarshal(b []byte) error

type StatsSink_Config 

type StatsSink_Config struct {
	Config *types.Struct `protobuf:"bytes,2,opt,name=config,proto3,oneof"`
}

type StatsSink_TypedConfig 

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

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"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

Stats configuration proto schema for built-in *envoy.statsd* sink. This sink does not support tagged metrics.

func (*StatsdSink) Descriptor 

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

func (*StatsdSink) GetAddress 

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

func (*StatsdSink) GetPrefix 

func (m *StatsdSink) GetPrefix() string

func (*StatsdSink) GetStatsdSpecifier 

func (m *StatsdSink) GetStatsdSpecifier() isStatsdSink_StatsdSpecifier

func (*StatsdSink) GetTcpClusterName 

func (m *StatsdSink) GetTcpClusterName() string

func (*StatsdSink) ProtoMessage 

func (*StatsdSink) ProtoMessage()

func (*StatsdSink) Reset 

func (m *StatsdSink) Reset()

func (*StatsdSink) String 

func (m *StatsdSink) String() string

func (*StatsdSink) XXX_DiscardUnknown 

func (m *StatsdSink) XXX_DiscardUnknown()

func (*StatsdSink) XXX_Marshal 

func (m *StatsdSink) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*StatsdSink) XXX_Merge 

func (m *StatsdSink) XXX_Merge(src proto.Message)

func (*StatsdSink) XXX_OneofWrappers 

func (*StatsdSink) XXX_OneofWrappers() []interface{}

XXX_OneofWrappers is for the internal use of the proto package.

func (*StatsdSink) XXX_Size 

func (m *StatsdSink) XXX_Size() int

func (*StatsdSink) XXX_Unmarshal 

func (m *StatsdSink) XXX_Unmarshal(b []byte) error

type StatsdSink_Address 

type StatsdSink_Address struct {
	Address *core.Address `protobuf:"bytes,1,opt,name=address,proto3,oneof"`
}

type StatsdSink_TcpClusterName 

type StatsdSink_TcpClusterName struct {
	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 valid to be assigned to TagValue:
	//	*TagSpecifier_Regex
	//	*TagSpecifier_FixedValue
	TagValue             isTagSpecifier_TagValue `protobuf_oneof:"tag_value"`
	XXX_NoUnkeyedLiteral struct{}                `json:"-"`
	XXX_unrecognized     []byte                  `json:"-"`
	XXX_sizecache        int32                   `json:"-"`
}

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 

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

func (*TagSpecifier) GetFixedValue 

func (m *TagSpecifier) GetFixedValue() string

func (*TagSpecifier) GetRegex 

func (m *TagSpecifier) GetRegex() string

func (*TagSpecifier) GetTagName 

func (m *TagSpecifier) GetTagName() string

func (*TagSpecifier) GetTagValue 

func (m *TagSpecifier) GetTagValue() isTagSpecifier_TagValue

func (*TagSpecifier) ProtoMessage 

func (*TagSpecifier) ProtoMessage()

func (*TagSpecifier) Reset 

func (m *TagSpecifier) Reset()

func (*TagSpecifier) String 

func (m *TagSpecifier) String() string

func (*TagSpecifier) XXX_DiscardUnknown 

func (m *TagSpecifier) XXX_DiscardUnknown()

func (*TagSpecifier) XXX_Marshal 

func (m *TagSpecifier) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*TagSpecifier) XXX_Merge 

func (m *TagSpecifier) XXX_Merge(src proto.Message)

func (*TagSpecifier) XXX_OneofWrappers 

func (*TagSpecifier) XXX_OneofWrappers() []interface{}

XXX_OneofWrappers is for the internal use of the proto package.

func (*TagSpecifier) XXX_Size 

func (m *TagSpecifier) XXX_Size() int

func (*TagSpecifier) XXX_Unmarshal 

func (m *TagSpecifier) XXX_Unmarshal(b []byte) error

type TagSpecifier_FixedValue 

type TagSpecifier_FixedValue struct {
	FixedValue string `protobuf:"bytes,3,opt,name=fixed_value,json=fixedValue,proto3,oneof"`
}

type TagSpecifier_Regex 

type TagSpecifier_Regex struct {
	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.