1syntax = "proto3";
2
3package envoy.config.metrics.v3;
4
5import "envoy/config/core/v3/config_source.proto";
6import "envoy/config/core/v3/grpc_service.proto";
7
8import "google/protobuf/wrappers.proto";
9
10import "udpa/annotations/status.proto";
11import "udpa/annotations/versioning.proto";
12import "validate/validate.proto";
13
14option java_package = "io.envoyproxy.envoy.config.metrics.v3";
15option java_outer_classname = "MetricsServiceProto";
16option java_multiple_files = true;
17option (udpa.annotations.file_status).package_version_status = ACTIVE;
18
19// [#protodoc-title: Metrics service]
20
21// Metrics Service is configured as a built-in *envoy.stat_sinks.metrics_service* :ref:`StatsSink
22// <envoy_api_msg_config.metrics.v3.StatsSink>`. This opaque configuration will be used to create
23// Metrics Service.
24// [#extension: envoy.stat_sinks.metrics_service]
25message MetricsServiceConfig {
26 option (udpa.annotations.versioning).previous_message_type =
27 "envoy.config.metrics.v2.MetricsServiceConfig";
28
29 // The upstream gRPC cluster that hosts the metrics service.
30 core.v3.GrpcService grpc_service = 1 [(validate.rules).message = {required: true}];
31
32 // API version for metric service transport protocol. This describes the metric service gRPC
33 // endpoint and version of messages used on the wire.
34 core.v3.ApiVersion transport_api_version = 3 [(validate.rules).enum = {defined_only: true}];
35
36 // If true, counters are reported as the delta between flushing intervals. Otherwise, the current
37 // counter value is reported. Defaults to false.
38 // Eventually (https://github.com/envoyproxy/envoy/issues/10968) if this value is not set, the
39 // sink will take updates from the :ref:`MetricsResponse <envoy_api_msg_service.metrics.v3.StreamMetricsResponse>`.
40 google.protobuf.BoolValue report_counters_as_deltas = 2;
41}
View as plain text