v2

package
v0.0.0-...-113c6ea Latest Latest
Warning

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

 Go to latest Published: Nov 27, 2019 License: Apache-2.0 Imports: 16 Imported by: 0

Documentation

Overview

Package v2 is a generated protocol buffer package.

It is generated from these files: 

envoy/config/metrics/v2/metrics_service.proto
envoy/config/metrics/v2/stats.proto

It has these top-level messages: 

MetricsServiceConfig
StatsSink
StatsConfig
TagSpecifier
StatsdSink
DogStatsdSink
HystrixSink

Index

Constants

This section is empty.

Variables

View Source 
var (
	ErrInvalidLengthMetricsService = fmt.Errorf("proto: negative length found during unmarshaling")
	ErrIntOverflowMetricsService   = fmt.Errorf("proto: integer overflow")
)
View Source 
var (
	ErrInvalidLengthStats = fmt.Errorf("proto: negative length found during unmarshaling")
	ErrIntOverflowStats   = fmt.Errorf("proto: integer overflow")
)

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

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>`. [#comment:next free field: 3]

func (*DogStatsdSink) Descriptor 

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

func (*DogStatsdSink) GetAddress 

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

func (*DogStatsdSink) GetDogStatsdSpecifier 

func (m *DogStatsdSink) GetDogStatsdSpecifier() isDogStatsdSink_DogStatsdSpecifier

func (*DogStatsdSink) Marshal 

func (m *DogStatsdSink) Marshal() (dAtA []byte, err error)

func (*DogStatsdSink) MarshalTo 

func (m *DogStatsdSink) MarshalTo(dAtA []byte) (int, error)

func (*DogStatsdSink) ProtoMessage 

func (*DogStatsdSink) ProtoMessage()

func (*DogStatsdSink) Reset 

func (m *DogStatsdSink) Reset()

func (*DogStatsdSink) Size 

func (m *DogStatsdSink) Size() (n int)

func (*DogStatsdSink) String 

func (m *DogStatsdSink) String() string

func (*DogStatsdSink) Unmarshal 

func (m *DogStatsdSink) Unmarshal(dAtA []byte) error

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, an error is returned.

func (*DogStatsdSink) XXX_OneofFuncs 

func (*DogStatsdSink) XXX_OneofFuncs() (func(msg proto.Message, b *proto.Buffer) error, func(msg proto.Message, tag, wire int, b *proto.Buffer) (bool, error), func(msg proto.Message) (n int), []interface{})

XXX_OneofFuncs is for the internal use of the proto package.

type DogStatsdSinkValidationError 

type DogStatsdSinkValidationError struct {
	Field  string
	Reason string
	Cause  error
	Key    bool
}

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

func (DogStatsdSinkValidationError) Error 

func (e DogStatsdSinkValidationError) Error() string

Error satisfies the builtin error interface

type DogStatsdSink_Address 

type DogStatsdSink_Address struct {
	Address *envoy_api_v2_core2.Address `protobuf:"bytes,1,opt,name=address,oneof"`
}

func (*DogStatsdSink_Address) MarshalTo 

func (m *DogStatsdSink_Address) MarshalTo(dAtA []byte) (int, error)

func (*DogStatsdSink_Address) Size 

func (m *DogStatsdSink_Address) Size() (n int)

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

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

func (m *HystrixSink) Marshal() (dAtA []byte, err error)

func (*HystrixSink) MarshalTo 

func (m *HystrixSink) MarshalTo(dAtA []byte) (int, error)

func (*HystrixSink) ProtoMessage 

func (*HystrixSink) ProtoMessage()

func (*HystrixSink) Reset 

func (m *HystrixSink) Reset()

func (*HystrixSink) Size 

func (m *HystrixSink) Size() (n int)

func (*HystrixSink) String 

func (m *HystrixSink) String() string

func (*HystrixSink) Unmarshal 

func (m *HystrixSink) Unmarshal(dAtA []byte) error

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, an error is returned.

type HystrixSinkValidationError 

type HystrixSinkValidationError struct {
	Field  string
	Reason string
	Cause  error
	Key    bool
}

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

func (HystrixSinkValidationError) Error 

func (e HystrixSinkValidationError) Error() string

Error satisfies the builtin error interface

type MetricsServiceConfig 

type MetricsServiceConfig struct {
	// The upstream gRPC cluster that hosts the metrics service.
	GrpcService *envoy_api_v2_core1.GrpcService `protobuf:"bytes,1,opt,name=grpc_service,json=grpcService" json:"grpc_service,omitempty"`
}

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

func (*MetricsServiceConfig) Marshal 

func (m *MetricsServiceConfig) Marshal() (dAtA []byte, err error)

func (*MetricsServiceConfig) MarshalTo 

func (m *MetricsServiceConfig) MarshalTo(dAtA []byte) (int, error)

func (*MetricsServiceConfig) ProtoMessage 

func (*MetricsServiceConfig) ProtoMessage()

func (*MetricsServiceConfig) Reset 

func (m *MetricsServiceConfig) Reset()

func (*MetricsServiceConfig) Size 

func (m *MetricsServiceConfig) Size() (n int)

func (*MetricsServiceConfig) String 

func (m *MetricsServiceConfig) String() string

func (*MetricsServiceConfig) Unmarshal 

func (m *MetricsServiceConfig) Unmarshal(dAtA []byte) error

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, an error is returned.

type MetricsServiceConfigValidationError 

type MetricsServiceConfigValidationError struct {
	Field  string
	Reason string
	Cause  error
	Key    bool
}

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

func (MetricsServiceConfigValidationError) Error 

func (e MetricsServiceConfigValidationError) Error() string

Error satisfies the builtin error interface

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" 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 `well_known_names.h
	// <https://github.com/envoyproxy/envoy/blob/master/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 *google_protobuf1.BoolValue `protobuf:"bytes,2,opt,name=use_all_default_tags,json=useAllDefaultTags" json:"use_all_default_tags,omitempty"`
}

Statistics configuration such as tagging.

func (*StatsConfig) Descriptor 

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

func (*StatsConfig) GetStatsTags 

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

func (*StatsConfig) GetUseAllDefaultTags 

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

func (*StatsConfig) Marshal 

func (m *StatsConfig) Marshal() (dAtA []byte, err error)

func (*StatsConfig) MarshalTo 

func (m *StatsConfig) MarshalTo(dAtA []byte) (int, error)

func (*StatsConfig) ProtoMessage 

func (*StatsConfig) ProtoMessage()

func (*StatsConfig) Reset 

func (m *StatsConfig) Reset()

func (*StatsConfig) Size 

func (m *StatsConfig) Size() (n int)

func (*StatsConfig) String 

func (m *StatsConfig) String() string

func (*StatsConfig) Unmarshal 

func (m *StatsConfig) Unmarshal(dAtA []byte) error

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, an error is returned.

type StatsConfigValidationError 

type StatsConfigValidationError struct {
	Field  string
	Reason string
	Cause  error
	Key    bool
}

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

func (StatsConfigValidationError) Error 

func (e StatsConfigValidationError) Error() string

Error satisfies the builtin error interface

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.
	Config *google_protobuf.Struct `protobuf:"bytes,2,opt,name=config" json:"config,omitempty"`
}

Configuration for pluggable stats sinks.

func (*StatsSink) Descriptor 

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

func (*StatsSink) GetConfig 

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

func (*StatsSink) GetName 

func (m *StatsSink) GetName() string

func (*StatsSink) Marshal 

func (m *StatsSink) Marshal() (dAtA []byte, err error)

func (*StatsSink) MarshalTo 

func (m *StatsSink) MarshalTo(dAtA []byte) (int, error)

func (*StatsSink) ProtoMessage 

func (*StatsSink) ProtoMessage()

func (*StatsSink) Reset 

func (m *StatsSink) Reset()

func (*StatsSink) Size 

func (m *StatsSink) Size() (n int)

func (*StatsSink) String 

func (m *StatsSink) String() string

func (*StatsSink) Unmarshal 

func (m *StatsSink) Unmarshal(dAtA []byte) error

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, an error is returned.

type StatsSinkValidationError 

type StatsSinkValidationError struct {
	Field  string
	Reason string
	Cause  error
	Key    bool
}

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

func (StatsSinkValidationError) Error 

func (e StatsSinkValidationError) Error() string

Error satisfies the builtin error interface

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

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

func (m *StatsdSink) Marshal() (dAtA []byte, err error)

func (*StatsdSink) MarshalTo 

func (m *StatsdSink) MarshalTo(dAtA []byte) (int, error)

func (*StatsdSink) ProtoMessage 

func (*StatsdSink) ProtoMessage()

func (*StatsdSink) Reset 

func (m *StatsdSink) Reset()

func (*StatsdSink) Size 

func (m *StatsdSink) Size() (n int)

func (*StatsdSink) String 

func (m *StatsdSink) String() string

func (*StatsdSink) Unmarshal 

func (m *StatsdSink) Unmarshal(dAtA []byte) error

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, an error is returned.

func (*StatsdSink) XXX_OneofFuncs 

func (*StatsdSink) XXX_OneofFuncs() (func(msg proto.Message, b *proto.Buffer) error, func(msg proto.Message, tag, wire int, b *proto.Buffer) (bool, error), func(msg proto.Message) (n int), []interface{})

XXX_OneofFuncs is for the internal use of the proto package.

type StatsdSinkValidationError 

type StatsdSinkValidationError struct {
	Field  string
	Reason string
	Cause  error
	Key    bool
}

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

func (StatsdSinkValidationError) Error 

func (e StatsdSinkValidationError) Error() string

Error satisfies the builtin error interface

type StatsdSink_Address 

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

func (*StatsdSink_Address) MarshalTo 

func (m *StatsdSink_Address) MarshalTo(dAtA []byte) (int, error)

func (*StatsdSink_Address) Size 

func (m *StatsdSink_Address) Size() (n int)

type StatsdSink_TcpClusterName 

type StatsdSink_TcpClusterName struct {
	TcpClusterName string `protobuf:"bytes,2,opt,name=tcp_cluster_name,json=tcpClusterName,proto3,oneof"`
}

func (*StatsdSink_TcpClusterName) MarshalTo 

func (m *StatsdSink_TcpClusterName) MarshalTo(dAtA []byte) (int, error)

func (*StatsdSink_TcpClusterName) Size 

func (m *StatsdSink_TcpClusterName) Size() (n int)

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 `well_known_names.h
	// <https://github.com/envoyproxy/envoy/blob/master/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"`
}

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

func (m *TagSpecifier) Marshal() (dAtA []byte, err error)

func (*TagSpecifier) MarshalTo 

func (m *TagSpecifier) MarshalTo(dAtA []byte) (int, error)

func (*TagSpecifier) ProtoMessage 

func (*TagSpecifier) ProtoMessage()

func (*TagSpecifier) Reset 

func (m *TagSpecifier) Reset()

func (*TagSpecifier) Size 

func (m *TagSpecifier) Size() (n int)

func (*TagSpecifier) String 

func (m *TagSpecifier) String() string

func (*TagSpecifier) Unmarshal 

func (m *TagSpecifier) Unmarshal(dAtA []byte) error

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, an error is returned.

func (*TagSpecifier) XXX_OneofFuncs 

func (*TagSpecifier) XXX_OneofFuncs() (func(msg proto.Message, b *proto.Buffer) error, func(msg proto.Message, tag, wire int, b *proto.Buffer) (bool, error), func(msg proto.Message) (n int), []interface{})

XXX_OneofFuncs is for the internal use of the proto package.

type TagSpecifierValidationError 

type TagSpecifierValidationError struct {
	Field  string
	Reason string
	Cause  error
	Key    bool
}

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

func (TagSpecifierValidationError) Error 

func (e TagSpecifierValidationError) Error() string

Error satisfies the builtin error interface

type TagSpecifier_FixedValue 

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

func (*TagSpecifier_FixedValue) MarshalTo 

func (m *TagSpecifier_FixedValue) MarshalTo(dAtA []byte) (int, error)

func (*TagSpecifier_FixedValue) Size 

func (m *TagSpecifier_FixedValue) Size() (n int)

type TagSpecifier_Regex 

type TagSpecifier_Regex struct {
	Regex string `protobuf:"bytes,2,opt,name=regex,proto3,oneof"`
}

func (*TagSpecifier_Regex) MarshalTo 

func (m *TagSpecifier_Regex) MarshalTo(dAtA []byte) (int, error)

func (*TagSpecifier_Regex) Size 

func (m *TagSpecifier_Regex) Size() (n int)

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.