/
metrics_service.proto
51 lines (38 loc) · 1.71 KB
/
metrics_service.proto
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
syntax = "proto3";
package envoy.service.metrics.v3;
import "envoy/config/core/v3/base.proto";
import "metrics.proto";
import "udpa/annotations/versioning.proto";
import "validate/validate.proto";
option java_package = "io.envoyproxy.envoy.service.metrics.v3";
option java_outer_classname = "MetricsServiceProto";
option java_multiple_files = true;
option java_generic_services = true;
// [#protodoc-title: Metrics service]
// Service for streaming metrics to server that consumes the metrics data. It uses Prometheus metric
// data model as a standard to represent metrics information.
service MetricsService {
// Envoy will connect and send StreamMetricsMessage messages forever. It does not expect any
// response to be sent as nothing would be done in the case of failure.
rpc StreamMetrics(stream StreamMetricsMessage) returns (StreamMetricsResponse) {
}
}
message StreamMetricsResponse {
option (udpa.annotations.versioning).previous_message_type =
"envoy.service.metrics.v2.StreamMetricsResponse";
}
message StreamMetricsMessage {
option (udpa.annotations.versioning).previous_message_type =
"envoy.service.metrics.v2.StreamMetricsMessage";
message Identifier {
option (udpa.annotations.versioning).previous_message_type =
"envoy.service.metrics.v2.StreamMetricsMessage.Identifier";
// The node sending metrics over the stream.
config.core.v3.Node node = 1 [(validate.rules).message = {required: true}];
}
// Identifier data effectively is a structured metadata. As a performance optimization this will
// only be sent in the first message on the stream.
Identifier identifier = 1;
// A list of metric entries
repeated io.prometheus.client.MetricFamily envoy_metrics = 2;
}