stats

package
v1.24.2 Latest Latest
Warning

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

Go to latest
Published: Dec 6, 2024 License: Apache-2.0 Imports: 5 Imported by: 2

Documentation

Index

Constants

This section is empty.

Variables

View Source
var (
	MetricType_name = map[int32]string{
		0: "COUNTER",
		1: "GAUGE",
		2: "HISTOGRAM",
	}
	MetricType_value = map[string]int32{
		"COUNTER":   0,
		"GAUGE":     1,
		"HISTOGRAM": 2,
	}
)

Enum value maps for MetricType.

View Source
var (
	Reporter_name = map[int32]string{
		0: "UNSPECIFIED",
		1: "SERVER_GATEWAY",
	}
	Reporter_value = map[string]int32{
		"UNSPECIFIED":    0,
		"SERVER_GATEWAY": 1,
	}
)

Enum value maps for Reporter.

View Source
var File_envoy_extensions_stats_config_proto protoreflect.FileDescriptor

Functions

This section is empty.

Types

type MetricConfig

type MetricConfig struct {

	// (Optional) Collection of tag names and tag expressions to include in the
	// metric. Conflicts are resolved by the tag name by overriding previously
	// supplied values.
	Dimensions map[string]string `` /* 161-byte string literal not displayed */
	// (Optional) Metric name to restrict the override to a metric. If not
	// specified, applies to all.
	Name string `protobuf:"bytes,2,opt,name=name,proto3" json:"name,omitempty"`
	// (Optional) A list of tags to remove.
	TagsToRemove []string `protobuf:"bytes,3,rep,name=tags_to_remove,json=tagsToRemove,proto3" json:"tags_to_remove,omitempty"`
	// NOT IMPLEMENTED. (Optional) Conditional enabling the override.
	Match string `protobuf:"bytes,4,opt,name=match,proto3" json:"match,omitempty"`
	// (Optional) If this is set to true, the metric(s) selected by this
	// configuration will not be generated or reported.
	Drop bool `protobuf:"varint,5,opt,name=drop,proto3" json:"drop,omitempty"`
	// contains filtered or unexported fields
}

Metric instance configuration overrides. The metric value and the metric type are optional and permit changing the reported value for an existing metric. The standard metrics are optimized and reported through a "fast-path". The customizations allow full configurability, at the cost of a "slower" path.

func (*MetricConfig) Descriptor deprecated

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

Deprecated: Use MetricConfig.ProtoReflect.Descriptor instead.

func (*MetricConfig) GetDimensions

func (x *MetricConfig) GetDimensions() map[string]string

func (*MetricConfig) GetDrop

func (x *MetricConfig) GetDrop() bool

func (*MetricConfig) GetMatch

func (x *MetricConfig) GetMatch() string

func (*MetricConfig) GetName

func (x *MetricConfig) GetName() string

func (*MetricConfig) GetTagsToRemove

func (x *MetricConfig) GetTagsToRemove() []string

func (*MetricConfig) ProtoMessage

func (*MetricConfig) ProtoMessage()

func (*MetricConfig) ProtoReflect

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

func (*MetricConfig) Reset

func (x *MetricConfig) Reset()

func (*MetricConfig) String

func (x *MetricConfig) String() string

type MetricDefinition

type MetricDefinition struct {

	// Metric name.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Metric value expression.
	Value string `protobuf:"bytes,2,opt,name=value,proto3" json:"value,omitempty"`
	// NOT IMPLEMENTED (Optional) Metric type.
	Type MetricType `protobuf:"varint,3,opt,name=type,proto3,enum=stats.MetricType" json:"type,omitempty"`
	// contains filtered or unexported fields
}

func (*MetricDefinition) Descriptor deprecated

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

Deprecated: Use MetricDefinition.ProtoReflect.Descriptor instead.

func (*MetricDefinition) GetName

func (x *MetricDefinition) GetName() string

func (*MetricDefinition) GetType

func (x *MetricDefinition) GetType() MetricType

func (*MetricDefinition) GetValue

func (x *MetricDefinition) GetValue() string

func (*MetricDefinition) ProtoMessage

func (*MetricDefinition) ProtoMessage()

func (*MetricDefinition) ProtoReflect

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

func (*MetricDefinition) Reset

func (x *MetricDefinition) Reset()

func (*MetricDefinition) String

func (x *MetricDefinition) String() string

type MetricType

type MetricType int32
const (
	MetricType_COUNTER   MetricType = 0
	MetricType_GAUGE     MetricType = 1
	MetricType_HISTOGRAM MetricType = 2
)

func (MetricType) Descriptor

func (MetricType) Descriptor() protoreflect.EnumDescriptor

func (MetricType) Enum

func (x MetricType) Enum() *MetricType

func (MetricType) EnumDescriptor deprecated

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

Deprecated: Use MetricType.Descriptor instead.

func (MetricType) Number

func (x MetricType) Number() protoreflect.EnumNumber

func (MetricType) String

func (x MetricType) String() string

func (MetricType) Type

type PluginConfig

type PluginConfig struct {

	// next id: 7
	// The following settings should be rarely used.
	// Enable debug for this filter.
	// DEPRECATED.
	Debug bool `protobuf:"varint,1,opt,name=debug,proto3" json:"debug,omitempty"`
	// maximum size of the peer metadata cache.
	// A long lived proxy that connects with many transient peers can build up a
	// large cache. To turn off the cache, set this field to a negative value.
	// DEPRECATED.
	MaxPeerCacheSize int32 `protobuf:"varint,2,opt,name=max_peer_cache_size,json=maxPeerCacheSize,proto3" json:"max_peer_cache_size,omitempty"`
	// prefix to add to stats emitted by the plugin.
	// DEPRECATED.
	StatPrefix string `protobuf:"bytes,3,opt,name=stat_prefix,json=statPrefix,proto3" json:"stat_prefix,omitempty"` // default: "istio_"
	// Stats api squashes dimensions in a single string.
	// The squashed string is parsed at prometheus scrape time to recover
	// dimensions. The following 2 fields set the field and value separators {key:
	// value} -->  key{value_separator}value{field_separator}
	FieldSeparator string `protobuf:"bytes,4,opt,name=field_separator,json=fieldSeparator,proto3" json:"field_separator,omitempty"` // default: ";;"
	ValueSeparator string `protobuf:"bytes,5,opt,name=value_separator,json=valueSeparator,proto3" json:"value_separator,omitempty"` // default: "=="
	// Optional: Disable using host header as a fallback if destination service is
	// not available from the controlplane. Disable the fallback if the host
	// header originates outsides the mesh, like at ingress.
	DisableHostHeaderFallback bool `` /* 141-byte string literal not displayed */
	// Optional. Allows configuration of the time between calls out to for TCP
	// metrics reporting. The default duration is `15s`.
	TcpReportingDuration *duration.Duration `protobuf:"bytes,7,opt,name=tcp_reporting_duration,json=tcpReportingDuration,proto3" json:"tcp_reporting_duration,omitempty"`
	// Metric overrides.
	Metrics []*MetricConfig `protobuf:"bytes,8,rep,name=metrics,proto3" json:"metrics,omitempty"`
	// Metric definitions.
	Definitions []*MetricDefinition `protobuf:"bytes,9,rep,name=definitions,proto3" json:"definitions,omitempty"`
	// Proxy deployment type.
	// $hide_from_docs
	Reporter Reporter `protobuf:"varint,10,opt,name=reporter,proto3,enum=stats.Reporter" json:"reporter,omitempty"`
	// Metric scope rotation interval. Set to 0 to disable the metric scope rotation.
	// Defaults to 0.
	// $hide_from_docs
	RotationInterval *duration.Duration `protobuf:"bytes,11,opt,name=rotation_interval,json=rotationInterval,proto3" json:"rotation_interval,omitempty"`
	// Metric expiry graceful deletion interval. No-op if the metric rotation is disabled.
	// Defaults to 5m. Must be >=1s.
	// $hide_from_docs
	GracefulDeletionInterval *duration.Duration `` /* 136-byte string literal not displayed */
	// contains filtered or unexported fields
}

func (*PluginConfig) Descriptor deprecated

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

Deprecated: Use PluginConfig.ProtoReflect.Descriptor instead.

func (*PluginConfig) GetDebug

func (x *PluginConfig) GetDebug() bool

func (*PluginConfig) GetDefinitions

func (x *PluginConfig) GetDefinitions() []*MetricDefinition

func (*PluginConfig) GetDisableHostHeaderFallback

func (x *PluginConfig) GetDisableHostHeaderFallback() bool

func (*PluginConfig) GetFieldSeparator

func (x *PluginConfig) GetFieldSeparator() string

func (*PluginConfig) GetGracefulDeletionInterval

func (x *PluginConfig) GetGracefulDeletionInterval() *duration.Duration

func (*PluginConfig) GetMaxPeerCacheSize

func (x *PluginConfig) GetMaxPeerCacheSize() int32

func (*PluginConfig) GetMetrics

func (x *PluginConfig) GetMetrics() []*MetricConfig

func (*PluginConfig) GetReporter

func (x *PluginConfig) GetReporter() Reporter

func (*PluginConfig) GetRotationInterval

func (x *PluginConfig) GetRotationInterval() *duration.Duration

func (*PluginConfig) GetStatPrefix

func (x *PluginConfig) GetStatPrefix() string

func (*PluginConfig) GetTcpReportingDuration

func (x *PluginConfig) GetTcpReportingDuration() *duration.Duration

func (*PluginConfig) GetValueSeparator

func (x *PluginConfig) GetValueSeparator() string

func (*PluginConfig) ProtoMessage

func (*PluginConfig) ProtoMessage()

func (*PluginConfig) ProtoReflect

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

func (*PluginConfig) Reset

func (x *PluginConfig) Reset()

func (*PluginConfig) String

func (x *PluginConfig) String() string

type Reporter

type Reporter int32

Specifies the proxy deployment type.

const (
	// Default value is inferred from the listener direction, as either client or
	// server sidecar.
	Reporter_UNSPECIFIED Reporter = 0
	// Shared server gateway, e.g. "waypoint".
	Reporter_SERVER_GATEWAY Reporter = 1
)

func (Reporter) Descriptor

func (Reporter) Descriptor() protoreflect.EnumDescriptor

func (Reporter) Enum

func (x Reporter) Enum() *Reporter

func (Reporter) EnumDescriptor deprecated

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

Deprecated: Use Reporter.Descriptor instead.

func (Reporter) Number

func (x Reporter) Number() protoreflect.EnumNumber

func (Reporter) String

func (x Reporter) String() string

func (Reporter) Type

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL