-
Notifications
You must be signed in to change notification settings - Fork 4k
otel: add tcp metrics #12652
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: master
Are you sure you want to change the base?
otel: add tcp metrics #12652
Changes from all commits
4082b2d
a8b66f4
1ee21f3
20c614f
53a0810
30cad78
9dfa829
2fda6fa
b12a433
d8180d6
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,104 @@ | ||
| /* | ||
| * 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.ArrayList; | ||
| import java.util.Arrays; | ||
| import java.util.Collections; | ||
| import java.util.List; | ||
|
|
||
| /** | ||
| * TCP Metrics defined to be shared across transport implementations. | ||
| */ | ||
| @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", | ||
| getMinRttBuckets(), | ||
| 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 | ||
| ); | ||
|
|
||
| private static List<Double> getMinRttBuckets() { | ||
| List<Double> buckets = new ArrayList<>(100); | ||
| for (int i = 1; i <= 100; i++) { | ||
| buckets.add(1e-6 * Math.pow(2.0, i * 0.24)); | ||
| } | ||
| return Collections.unmodifiableList(buckets); | ||
| } | ||
| } | ||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -435,6 +435,16 @@ public T setBinaryLog(BinaryLog binaryLog) { | |
| */ | ||
| public abstract Server build(); | ||
|
|
||
| /** | ||
| * Adds a metric sink to the server. | ||
| * | ||
| * @param metricSink the metric sink to add. | ||
| * @return this | ||
| */ | ||
| public T addMetricSink(MetricSink metricSink) { | ||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
|
||
| throw new UnsupportedOperationException(); | ||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. If a server has no metrics, then they wouldn't implement this method. Seems this should just be a noop instead of throwing. (If it stays as throwing, we'd need to figure out how we wanted to handle it in GrpcOpenTelementry.) |
||
| } | ||
|
|
||
| /** | ||
| * Returns the correctly typed version of the builder. | ||
| */ | ||
|
|
||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Can you review go/java-practices/null from the overall PR's perspective in terms of nullable vs optional ? I am not sure if we have a local java convention to prefer or avoid null
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. We can't yet use java.util.Optional in many parts of the code because we don't require API desugaring and it was added in Android API level 24. We can use Guava's Optional, but we don't want it in any cross-module API surface; we only use Guava internally. Given Guava's Optional is semi-discouraged, but we can't use the new thing either, we've generally avoided the problem and not used Optional; there's very few usages of Optional in the code base. Note that |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is pretty specific, and a lot of buckets. Where did this come from?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I saw something similar in core...
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
If implementations are expected to do this, then it needs to be in the gRFC.