grpc-java/api/src/main/java/io/grpc/InternalTcpMetrics.java at b7dee4623c2c1dd78662f1e7558033b388ff3802 · AgraVator/grpc-java · GitHub

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
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
/*
 * Copyright 2026 The gRPC Authors
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package io.grpc;

import java.util.Arrays;
import java.util.Collections;
import java.util.List;

/**
 * TCP Metrics defined to be shared across transport implementations.
 * These metrics and their definitions are specified in
 * <a href=
 * "https://github.com/grpc/proposal/blob/master/A80-tcp-metrics.md">gRFC
 * A80</a>.
 */
@Internal
public final class InternalTcpMetrics {

  private InternalTcpMetrics() {
  }

  private static final List<String> OPTIONAL_LABELS = Arrays.asList(
      "network.local.address",
      "network.local.port",
      "network.peer.address",
      "network.peer.port");

  public static final DoubleHistogramMetricInstrument MIN_RTT_INSTRUMENT =
      MetricInstrumentRegistry.getDefaultRegistry()
          .registerDoubleHistogram(
              "grpc.tcp.min_rtt",
              "Minimum round-trip time of a TCP connection",
              "s",
              Collections.emptyList(),
              Collections.emptyList(),
              OPTIONAL_LABELS,
              false);

  public static final LongCounterMetricInstrument CONNECTIONS_CREATED_INSTRUMENT =
      MetricInstrumentRegistry
          .getDefaultRegistry()
          .registerLongCounter(
              "grpc.tcp.connections_created",
              "The total number of TCP connections established.",
              "{connection}",
              Collections.emptyList(),
              OPTIONAL_LABELS,
              false);

  public static final LongUpDownCounterMetricInstrument CONNECTION_COUNT_INSTRUMENT =
      MetricInstrumentRegistry
          .getDefaultRegistry()
          .registerLongUpDownCounter(
              "grpc.tcp.connection_count",
              "The current number of active TCP connections.",
              "{connection}",
              Collections.emptyList(),
              OPTIONAL_LABELS,
              false);

  public static final LongCounterMetricInstrument PACKETS_RETRANSMITTED_INSTRUMENT =
      MetricInstrumentRegistry
          .getDefaultRegistry()
          .registerLongCounter(
              "grpc.tcp.packets_retransmitted",
              "The total number of packets retransmitted for all TCP connections.",
              "{packet}",
              Collections.emptyList(),
              OPTIONAL_LABELS,
              false);

  public static final LongCounterMetricInstrument RECURRING_RETRANSMITS_INSTRUMENT =
      MetricInstrumentRegistry
          .getDefaultRegistry()
          .registerLongCounter(
              "grpc.tcp.recurring_retransmits",
              "The total number of times the retransmit timer "
                  + "popped for all TCP connections.",
              "{timeout}",
              Collections.emptyList(),
              OPTIONAL_LABELS,
              false);

}