package envoy.extensions.access_loggers.stats.v3

Get desktop application:
View/edit binary Protocol Buffers messages

[#next-free-field: 6]

• string stat_prefix = 1

  The stat prefix for the generated stats.

• repeated Config.Histogram histograms = 3

  The histograms this logger will emit.

• repeated Config.Counter counters = 4

  The counters this logger will emit.

• repeated Config.Gauge gauges = 5

  The gauges this logger will emit.

Configuration for a counter stat.

Used in: Config

• optional Stat stat = 1

  The name and tags of this counter.

• string value_format = 2

  The format string for the value to add to this counter, using :ref:`command operators <config_access_log_command_operators>`. One of ``value_format`` or ``value_fixed`` must be configured.

• optional google.protobuf.UInt64Value value_fixed = 3

  A fixed value to add to this counter. One of ``value_format`` or ``value_fixed`` must be configured.

Configuration for a gauge stat. Gauges can be used to add, subtract, or set values, and are useful for tracking concurrency or other mutable values over time. [#next-free-field: 6]

Used in: Config

• optional Stat stat = 1

  The name and tags of this gauge.

• string value_format = 2

  The format string for the value of this gauge, using :ref:`command operators <config_access_log_command_operators>`. This must evaluate to a positive number.

• optional google.protobuf.UInt64Value value_fixed = 3

  A fixed value to add/subtract/set to this gauge. One of ``value_format`` or ``value_fixed`` must be configured.

• optional Gauge.PairedAddSubtract add_subtract = 4

  The PairedAddSubtract operation. Only one of PairedAddSubtract and Set can be defined.

• optional Gauge.Set set = 5

  The Set operation. Only one of PairedAddSubtract and Set can be defined.

The PairedAddSubtract operation config. Usage restrictions: 1. We only support add first then subtract logic and we rely on the symmetrical log types (e.g., DownstreamStart/DownstreamEnd) to increment and decrement the gauge. 2. During runtime, sub_log_type will execute if and only if add_log_type operation has been done, tracked by inflight counter in filter state. 3. If the add_log_type operation was executed, the sub_log_type will happen when the stream/connection is closed, even if the configured log type didn't happen.

Used in: Gauge

• data.accesslog.v3.AccessLogType add_log_type = 1

  The access log type to trigger the add operation.

• data.accesslog.v3.AccessLogType sub_log_type = 2

  The access log type to trigger the subtract operation.

The Set operation config.

Used in: Gauge

• data.accesslog.v3.AccessLogType log_type = 1

  The access log type to trigger the operation.

Configuration for a histogram stat.

Used in: Config

• optional Stat stat = 1

  The name and tags of this histogram.

• Histogram.Unit unit = 2

  The units for this histogram.

• string value_format = 3

  The format string for the value of this histogram, using :ref:`command operators <config_access_log_command_operators>`. This must evaluate to a positive number.

The histogram units. The units are needed for some stat sinks.

Used in: Histogram

• Unspecified = 0

• Bytes = 1

• Microseconds = 2

• Milliseconds = 3

• Percent = 4

  Values are scaled to range 0-1.0, indicating 0%-100%. Values can be outside this range, but must be positive. Values extremely far out of this range may overflow.

Defines the name and tags of a stat.

Used in: Counter, Gauge, Histogram

• string name = 1

  The name of the stat.

• repeated Tag tags = 2

  The tags for the stat.

Defines a tag on a stat.

Used in: Stat

• string name = 1

  The name of the tag.

• string value_format = 2

  The value of the tag, using :ref:`command operators <config_access_log_command_operators>`.

• optional xds.type.matcher.v3.Matcher rules = 3

  The custom rules to generate the stat tags. Currently, the only supported input is :ref:`Stat tag value input <envoy_v3_api_msg_extensions.matching.common_inputs.stats.v3.StatTagValueInput>`. The supported actions are - :ref:`Transform stat action <envoy_v3_api_msg_extensions.matching.actions.transform_stat.v3.TransformStat>`.