Struct StatsMatcher

pub struct StatsMatcher {
    pub stats_matcher: Option<StatsMatcher>,
}

Configuration for disabling stat instantiation.

The instantiation of stats is unrestricted by default. If the goal is to configure Envoy to instantiate all stats, there is no need to construct a StatsMatcher.

However, StatsMatcher can be used to limit the creation of families of stats in order to conserve memory. Stats can either be disabled entirely, or they can be limited by either an exclusion or an inclusion list of :ref:StringMatcher <envoy_v3_api_msg_type.matcher.v3.StringMatcher> protos:

• If reject_all is set to true, no stats will be instantiated. If reject_all is set to false, all stats will be instantiated.

• If an exclusion list is supplied, any stat name matching any of the StringMatchers in the list will not instantiate.

• If an inclusion list is supplied, no stats will instantiate, except those matching any of the StringMatchers in the list.

A StringMatcher can be used to match against an exact string, a suffix / prefix, or a regex. NB: For performance reasons, it is highly recommended to use a prefix- or suffix-based matcher rather than a regex-based matcher.

Example 1. Excluding all stats.

.. code-block:: json

{ “statsMatcher”: { “rejectAll”: “true” } }

Example 2. Excluding all cluster-specific stats, but not cluster-manager stats:

.. code-block:: json

{ “statsMatcher”: { “exclusionList”: { “patterns”: [ { “prefix”: “cluster.” } ] } } }

Example 3. Including only manager-related stats:

.. code-block:: json

{ “statsMatcher”: { “inclusionList”: { “patterns”: [ { “prefix”: “cluster_manager.” }, { “prefix”: “listener_manager.” } ] } } }

Fields

stats_matcher: Option<StatsMatcher>

Trait Implementations

impl Clone for StatsMatcher

fn clone(&self) -> StatsMatcher

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for StatsMatcher

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

Formats the value using the given formatter.

impl Default for StatsMatcher

fn default() -> Self

Returns the “default value” for a type.

impl Message for StatsMatcher

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 StatsMatcher

const NAME: &'static str = "StatsMatcher"

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 StatsMatcher

fn eq(&self, other: &StatsMatcher) -> 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 StatsMatcher