Struct StatsConfig

pub struct StatsConfig {
    pub stats_tags: Vec<TagSpecifier>,
    pub use_all_default_tags: Option<BoolValue>,
    pub stats_matcher: Option<StatsMatcher>,
    pub histogram_bucket_settings: Vec<HistogramBucketSettings>,
}

Statistics configuration such as tagging.

Fields

stats_tags: Vec<TagSpecifier>

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.

use_all_default_tags: Option<BoolValue>

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.

stats_matcher: Option<StatsMatcher>

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.

histogram_bucket_settings: Vec<HistogramBucketSettings>

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
 ]

Trait Implementations

impl Clone for StatsConfig

fn clone(&self) -> StatsConfig

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for StatsConfig

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for StatsConfig

fn default() -> Self

Returns the “default value” for a type.

impl Message for StatsConfig

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode(&self, buf: &mut impl BufMut) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message to a buffer.

fn encode_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message to a newly allocated buffer.

fn encode_length_delimited( &self, buf: &mut impl BufMut, ) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message with a length-delimiter to a buffer.

fn encode_length_delimited_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message with a length-delimiter to a newly allocated buffer.

fn decode(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes an instance of the message from a buffer.

fn decode_length_delimited(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes a length-delimited instance of the message from the buffer.

fn merge(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl Name for StatsConfig

const NAME: &'static str = "StatsConfig"

Simple name for this Message. This name is the same as it appears in the source .proto file, e.g. FooBar.

const PACKAGE: &'static str = "envoy.config.metrics.v3"

Package name this message type is contained in. They are domain-like and delimited by ., e.g. google.protobuf.

fn full_name() -> String

Fully-qualified unique name for this Message. It’s prefixed with the package name and names of any parent messages, e.g. google.rpc.BadRequest.FieldViolation. By default, this is the package name followed by the message name. Fully-qualified names must be unique within a domain of Type URLs.

fn type_url() -> String

Type URL for this Message, which by default is the full name with a leading slash, but may also include a leading domain name, e.g. type.googleapis.com/google.profile.Person. This can be used when serializing into the google.protobuf.Any type.

impl PartialEq for StatsConfig

fn eq(&self, other: &StatsConfig) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for StatsConfig