Struct MetricsServiceConfig

pub struct MetricsServiceConfig {
    pub grpc_service: Option<GrpcService>,
    pub transport_api_version: i32,
    pub report_counters_as_deltas: Option<BoolValue>,
    pub emit_tags_as_labels: bool,
    pub histogram_emit_mode: i32,
}

Metrics Service is configured as a built-in envoy.stat_sinks.metrics_service :ref:StatsSink <envoy_v3_api_msg_config.metrics.v3.StatsSink>. This opaque configuration will be used to create Metrics Service.

Example:

.. code-block:: yaml

 stats_sinks:
   - name: envoy.stat_sinks.metrics_service
     typed_config:
       "@type": type.googleapis.com/envoy.config.metrics.v3.MetricsServiceConfig

[#extension: envoy.stat_sinks.metrics_service] [#next-free-field: 6]

Fields

grpc_service: Option<GrpcService>

The upstream gRPC cluster that hosts the metrics service.

transport_api_version: i32

API version for metric service transport protocol. This describes the metric service gRPC endpoint and version of messages used on the wire.

report_counters_as_deltas: Option<BoolValue>

If true, counters are reported as the delta between flushing intervals. Otherwise, the current counter value is reported. Defaults to false. Eventually (https://github.com/envoyproxy/envoy/issues/10968) if this value is not set, the sink will take updates from the :ref:MetricsResponse <envoy_v3_api_msg_service.metrics.v3.StreamMetricsResponse>.

emit_tags_as_labels: bool

If true, metrics will have their tags emitted as labels on the metrics objects sent to the MetricsService, and the tag extracted name will be used instead of the full name, which may contain values used by the tag extractor or additional tags added during stats creation.

histogram_emit_mode: i32

Specify which metrics types to emit for histograms. Defaults to SUMMARY_AND_HISTOGRAM.

Implementations

impl MetricsServiceConfig

pub fn transport_api_version(&self) -> ApiVersion

Returns the enum value of transport_api_version, or the default if the field is set to an invalid enum value.

pub fn set_transport_api_version(&mut self, value: ApiVersion)

Sets transport_api_version to the provided enum value.

pub fn histogram_emit_mode(&self) -> HistogramEmitMode

Returns the enum value of histogram_emit_mode, or the default if the field is set to an invalid enum value.

pub fn set_histogram_emit_mode(&mut self, value: HistogramEmitMode)

Sets histogram_emit_mode to the provided enum value.

Trait Implementations

impl Clone for MetricsServiceConfig

fn clone(&self) -> MetricsServiceConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for MetricsServiceConfig

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

Formats the value using the given formatter.

impl Default for MetricsServiceConfig

fn default() -> Self

Returns the “default value” for a type.

impl Message for MetricsServiceConfig

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 MetricsServiceConfig

const NAME: &'static str = "MetricsServiceConfig"

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 MetricsServiceConfig

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