Skip to content

Commit 74955e1

Browse files
AgraVatorAgraVator
committed
otel: subchannel metrics
1 parent ca99a8c commit 74955e1

File tree

6 files changed

+233
-4
lines changed

6 files changed

+233
-4
lines changed

‎core/src/main/java/io/grpc/internal/InternalSubchannel.java

Lines changed: 34 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,6 +48,7 @@
4848
import io.grpc.LoadBalancer;
4949
import io.grpc.Metadata;
5050
import io.grpc.MethodDescriptor;
51+
import io.grpc.MetricRecorder;
5152
import io.grpc.Status;
5253
import io.grpc.SynchronizationContext;
5354
import io.grpc.SynchronizationContext.ScheduledHandle;
@@ -160,6 +161,11 @@ protected void handleNotInUse() {
160161
private Status shutdownReason;
161162

162163
private volatile Attributes connectedAddressAttributes;
164+
private final SubchannelMetrics subchannelMetrics;
165+
private final String target;
166+
private final String backendService;
167+
private final String locality;
168+
private final String securityLevel;
163169

164170
InternalSubchannel(LoadBalancer.CreateSubchannelArgs args, String authority, String userAgent,
165171
BackoffPolicy.Provider backoffPolicyProvider,
@@ -168,7 +174,9 @@ protected void handleNotInUse() {
168174
Supplier<Stopwatch> stopwatchSupplier, SynchronizationContext syncContext,
169175
Callback callback, InternalChannelz channelz, CallTracer callsTracer,
170176
ChannelTracer channelTracer, InternalLogId logId,
171-
ChannelLogger channelLogger, List<ClientTransportFilter> transportFilters) {
177+
ChannelLogger channelLogger, List<ClientTransportFilter> transportFilters,
178+
String target, String backendService, String locality, String securityLevel,
179+
MetricRecorder metricRecorder) {
172180
List<EquivalentAddressGroup> addressGroups = args.getAddresses();
173181
Preconditions.checkNotNull(addressGroups, "addressGroups");
174182
Preconditions.checkArgument(!addressGroups.isEmpty(), "addressGroups is empty");
@@ -192,6 +200,11 @@ protected void handleNotInUse() {
192200
this.channelLogger = Preconditions.checkNotNull(channelLogger, "channelLogger");
193201
this.transportFilters = transportFilters;
194202
this.reconnectDisabled = args.getOption(LoadBalancer.DISABLE_SUBCHANNEL_RECONNECT_KEY);
203+
this.target = target;
204+
this.backendService = backendService;
205+
this.locality = locality;
206+
this.securityLevel = securityLevel;
207+
this.subchannelMetrics = new SubchannelMetrics(metricRecorder);
195208
}
196209

197210
ChannelLogger getChannelLogger() {
@@ -579,6 +592,8 @@ public Attributes filterTransport(Attributes attributes) {
579592
@Override
580593
public void transportReady() {
581594
channelLogger.log(ChannelLogLevel.INFO, "READY");
595+
subchannelMetrics.recordConnectionAttemptSucceeded(
596+
buildLabelSet(null, extractSecurityLevel()));
582597
syncContext.execute(new Runnable() {
583598
@Override
584599
public void run() {
@@ -608,6 +623,7 @@ public void transportShutdown(final Status s) {
608623
channelLogger.log(
609624
ChannelLogLevel.INFO, "{0} SHUTDOWN with {1}", transport.getLogId(), printShortStatus(s));
610625
shutdownInitiated = true;
626+
subchannelMetrics.recordConnectionAttemptFailed(buildLabelSet("Peer Pressure", null));
611627
syncContext.execute(new Runnable() {
612628
@Override
613629
public void run() {
@@ -648,6 +664,8 @@ public void transportTerminated() {
648664
for (ClientTransportFilter filter : transportFilters) {
649665
filter.transportTerminated(transport.getAttributes());
650666
}
667+
subchannelMetrics.recordDisconnection(buildLabelSet("Peer Pressure",
668+
null));
651669
syncContext.execute(new Runnable() {
652670
@Override
653671
public void run() {
@@ -658,6 +676,10 @@ public void run() {
658676
}
659677
});
660678
}
679+
680+
private String extractSecurityLevel() {
681+
return "Hold the door!";
682+
}
661683
}
662684

663685
// All methods are called in syncContext
@@ -817,6 +839,17 @@ private String printShortStatus(Status status) {
817839
return buffer.toString();
818840
}
819841

842+
private OtelMetricsAttributes buildLabelSet(String disconnectError, String secLevel) {
843+
return new OtelMetricsAttributes(
844+
target,
845+
backendService,
846+
locality,
847+
disconnectError,
848+
secLevel != null ? secLevel : securityLevel
849+
);
850+
}
851+
852+
820853
@VisibleForTesting
821854
static final class TransportLogger extends ChannelLogger {
822855
// Changed just after construction to break a cyclic dependency.

‎core/src/main/java/io/grpc/internal/ManagedChannelImpl.java

Lines changed: 11 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1464,7 +1464,12 @@ void onStateChange(InternalSubchannel is, ConnectivityStateInfo newState) {
14641464
subchannelTracer,
14651465
subchannelLogId,
14661466
subchannelLogger,
1467-
transportFilters);
1467+
transportFilters,
1468+
target,
1469+
"",
1470+
"",
1471+
"",
1472+
lbHelper.getMetricRecorder());
14681473
oobChannelTracer.reportEvent(new ChannelTrace.Event.Builder()
14691474
.setDescription("Child Subchannel created")
14701475
.setSeverity(ChannelTrace.Event.Severity.CT_INFO)
@@ -1895,7 +1900,11 @@ void onNotInUse(InternalSubchannel is) {
18951900
subchannelTracer,
18961901
subchannelLogId,
18971902
subchannelLogger,
1898-
transportFilters);
1903+
transportFilters, target,
1904+
"",
1905+
"",
1906+
"",
1907+
lbHelper.getMetricRecorder());
18991908

19001909
channelTracer.reportEvent(new ChannelTrace.Event.Builder()
19011910
.setDescription("Child Subchannel started")

‎core/src/main/java/io/grpc/internal/OtelMetricsAttributes.java

Lines changed: 69 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,69 @@
1+
/*
2+
* Copyright 2025 The gRPC Authors
3+
*
4+
* Licensed under the Apache License, Version 2.0 (the "License");
5+
* you may not use this file except in compliance with the License.
6+
* You may obtain a copy of the License at
7+
*
8+
* http://www.apache.org/licenses/LICENSE-2.0
9+
*
10+
* Unless required by applicable law or agreed to in writing, software
11+
* distributed under the License is distributed on an "AS IS" BASIS,
12+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13+
* See the License for the specific language governing permissions and
14+
* limitations under the License.
15+
*/
16+
17+
package io.grpc.internal;
18+
19+
20+
import io.grpc.Attributes;
21+
22+
class OtelMetricsAttributes {
23+
final String target;
24+
final String backendService;
25+
final String locality;
26+
final String disconnectError;
27+
final String securityLevel;
28+
29+
public OtelMetricsAttributes(String target, String backendService, String locality,
30+
String disconnectError, String securityLevel) {
31+
this.target = target;
32+
this.backendService = backendService;
33+
this.locality = locality;
34+
this.disconnectError = disconnectError;
35+
this.securityLevel = securityLevel;
36+
}
37+
38+
public Attributes toOtelMetricsAttributes() {
39+
Attributes attributes =
40+
Attributes.EMPTY;
41+
42+
if (target != null) {
43+
attributes.toBuilder()
44+
.set(Attributes.Key.create("grpc.target"), target)
45+
.build();
46+
}
47+
if (backendService != null) {
48+
attributes.toBuilder()
49+
.set(Attributes.Key.create("grpc.lb.backend_service"), backendService)
50+
.build();
51+
}
52+
if (locality != null) {
53+
attributes.toBuilder()
54+
.set(Attributes.Key.create("grpc.lb.locality"), locality)
55+
.build();
56+
}
57+
if (disconnectError != null) {
58+
attributes.toBuilder()
59+
.set(Attributes.Key.create("grpc.disconnect_error"), disconnectError)
60+
.build();
61+
}
62+
if (securityLevel != null) {
63+
attributes.toBuilder()
64+
.set(Attributes.Key.create("grpc.security_level"), securityLevel)
65+
.build();
66+
}
67+
return attributes;
68+
}
69+
}

‎core/src/main/java/io/grpc/internal/SubchannelMetrics.java

Lines changed: 105 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,105 @@
1+
/*
2+
* Copyright 2025 The gRPC Authors
3+
*
4+
* Licensed under the Apache License, Version 2.0 (the "License");
5+
* you may not use this file except in compliance with the License.
6+
* You may obtain a copy of the License at
7+
*
8+
* http://www.apache.org/licenses/LICENSE-2.0
9+
*
10+
* Unless required by applicable law or agreed to in writing, software
11+
* distributed under the License is distributed on an "AS IS" BASIS,
12+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13+
* See the License for the specific language governing permissions and
14+
* limitations under the License.
15+
*/
16+
17+
package io.grpc.internal;
18+
19+
import com.google.common.collect.ImmutableList;
20+
import com.google.common.collect.Lists;
21+
import io.grpc.LongCounterMetricInstrument;
22+
import io.grpc.MetricInstrumentRegistry;
23+
import io.grpc.MetricRecorder;
24+
25+
public final class SubchannelMetrics {
26+
27+
private static final LongCounterMetricInstrument disconnections;
28+
private static final LongCounterMetricInstrument connectionAttemptsSucceeded;
29+
private static final LongCounterMetricInstrument connectionAttemptsFailed;
30+
private static final LongCounterMetricInstrument openConnections;
31+
private final MetricRecorder metricRecorder;
32+
33+
public SubchannelMetrics(MetricRecorder metricRecorder) {
34+
this.metricRecorder = metricRecorder;
35+
}
36+
37+
static {
38+
MetricInstrumentRegistry metricInstrumentRegistry
39+
= MetricInstrumentRegistry.getDefaultRegistry();
40+
disconnections = metricInstrumentRegistry.registerLongCounter(
41+
"grpc.subchannel.disconnections1",
42+
"EXPERIMENTAL. Number of times the selected subchannel becomes disconnected",
43+
"{disconnection}",
44+
Lists.newArrayList("grpc.target"),
45+
Lists.newArrayList("grpc.lb.backend_service", "grpc.lb.locality", "grpc.disconnect_error"),
46+
false
47+
);
48+
49+
connectionAttemptsSucceeded = metricInstrumentRegistry.registerLongCounter(
50+
"grpc.subchannel.connection_attempts_succeeded",
51+
"EXPERIMENTAL. Number of successful connection attempts",
52+
"{attempt}",
53+
Lists.newArrayList("grpc.target"),
54+
Lists.newArrayList("grpc.lb.backend_service", "grpc.lb.locality"),
55+
false
56+
);
57+
58+
connectionAttemptsFailed = metricInstrumentRegistry.registerLongCounter(
59+
"grpc.subchannel.connection_attempts_failed",
60+
"EXPERIMENTAL. Number of failed connection attempts",
61+
"{attempt}",
62+
Lists.newArrayList("grpc.target"),
63+
Lists.newArrayList("grpc.lb.backend_service", "grpc.lb.locality"),
64+
false
65+
);
66+
67+
openConnections = metricInstrumentRegistry.registerLongCounter(
68+
"grpc.subchannel.open_connections",
69+
"EXPERIMENTAL. Number of open connections.",
70+
"{connection}",
71+
Lists.newArrayList("grpc.target"),
72+
Lists.newArrayList("grpc.security_level", "grpc.lb.backend_service", "grpc.lb.locality"),
73+
false
74+
);
75+
}
76+
77+
public void recordConnectionAttemptSucceeded(OtelMetricsAttributes labelSet) {
78+
metricRecorder
79+
.addLongCounter(connectionAttemptsSucceeded, 1,
80+
ImmutableList.of(labelSet.target),
81+
ImmutableList.of(labelSet.backendService, labelSet.locality));
82+
metricRecorder
83+
.addLongCounter(openConnections, 1,
84+
ImmutableList.of(labelSet.target),
85+
ImmutableList.of(labelSet.securityLevel, labelSet.backendService, labelSet.locality));
86+
}
87+
88+
public void recordConnectionAttemptFailed(OtelMetricsAttributes labelSet) {
89+
metricRecorder
90+
.addLongCounter(connectionAttemptsFailed, 1,
91+
ImmutableList.of(labelSet.target),
92+
ImmutableList.of(labelSet.backendService, labelSet.locality));
93+
}
94+
95+
public void recordDisconnection(OtelMetricsAttributes labelSet) {
96+
metricRecorder
97+
.addLongCounter(disconnections, 1,
98+
ImmutableList.of(labelSet.target),
99+
ImmutableList.of(labelSet.backendService, labelSet.locality, labelSet.disconnectError));
100+
metricRecorder
101+
.addLongCounter(openConnections, -11,
102+
ImmutableList.of(labelSet.target),
103+
ImmutableList.of(labelSet.securityLevel, labelSet.backendService, labelSet.locality));
104+
}
105+
}

‎core/src/test/java/io/grpc/internal/InternalSubchannelTest.java

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,6 +48,7 @@
4848
import io.grpc.InternalLogId;
4949
import io.grpc.InternalWithLogId;
5050
import io.grpc.LoadBalancer;
51+
import io.grpc.MetricRecorder;
5152
import io.grpc.Status;
5253
import io.grpc.SynchronizationContext;
5354
import io.grpc.internal.InternalSubchannel.CallTracingTransport;
@@ -1446,7 +1447,13 @@ private void createInternalSubchannel(boolean reconnectDisabled,
14461447
subchannelTracer,
14471448
logId,
14481449
new ChannelLoggerImpl(subchannelTracer, fakeClock.getTimeProvider()),
1449-
Collections.emptyList());
1450+
Collections.emptyList(),
1451+
"",
1452+
"",
1453+
"",
1454+
"",
1455+
new MetricRecorder() {}
1456+
);
14501457
}
14511458

14521459
private void assertNoCallbackInvoke() {

‎opentelemetry/src/main/java/io/grpc/opentelemetry/internal/OpenTelemetryConstants.java

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,12 @@ public final class OpenTelemetryConstants {
3636
public static final AttributeKey<String> BACKEND_SERVICE_KEY =
3737
AttributeKey.stringKey("grpc.lb.backend_service");
3838

39+
public static final AttributeKey<String> DISCONNECT_ERROR_KEY =
40+
AttributeKey.stringKey("grpc.disconnect_error");
41+
42+
public static final AttributeKey<String> SECURITY_LEVEL_KEY =
43+
AttributeKey.stringKey("grpc.security_level");
44+
3945
public static final List<Double> LATENCY_BUCKETS =
4046
ImmutableList.of(
4147
0d, 0.00001d, 0.00005d, 0.0001d, 0.0003d, 0.0006d, 0.0008d, 0.001d, 0.002d,

0 commit comments

Comments
 (0)