Skip to content
This repository was archived by the owner on May 8, 2026. It is now read-only.

Commit 17722a4

Browse files
chore: start pulling all metrics related things together under MetricsImpl
Change-Id: I78a5d0fed976381bd952ca405c36ce22e8c6178f
1 parent be51db4 commit 17722a4

5 files changed

Lines changed: 250 additions & 152 deletions

File tree

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
/*
2+
* Copyright 2026 Google LLC
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+
* https://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+
package com.google.cloud.bigtable.data.v2.internal.csm;
17+
18+
import com.google.api.gax.tracing.ApiTracerFactory;
19+
import com.google.cloud.bigtable.data.v2.internal.csm.attributes.ClientInfo;
20+
import com.google.cloud.bigtable.data.v2.stub.metrics.ChannelPoolMetricsTracer;
21+
import io.grpc.ManagedChannelBuilder;
22+
import java.io.Closeable;
23+
import java.io.IOException;
24+
import javax.annotation.Nullable;
25+
26+
public interface Metrics extends Closeable {
27+
ApiTracerFactory createTracerFactory(ClientInfo clientInfo) throws IOException;
28+
29+
<T extends ManagedChannelBuilder<?>> T configureGrpcChannel(T channelBuilder);
30+
31+
@Nullable
32+
ChannelPoolMetricsTracer getChannelPoolMetricsTracer();
33+
34+
void start();
35+
36+
@Override
37+
void close();
38+
}
Lines changed: 180 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,180 @@
1+
/*
2+
* Copyright 2026 Google LLC
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+
* https://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+
package com.google.cloud.bigtable.data.v2.internal.csm;
17+
18+
import com.google.api.gax.grpc.GaxGrpcProperties;
19+
import com.google.api.gax.tracing.ApiTracerFactory;
20+
import com.google.api.gax.tracing.OpencensusTracerFactory;
21+
import com.google.cloud.bigtable.Version;
22+
import com.google.cloud.bigtable.data.v2.internal.csm.attributes.ClientInfo;
23+
import com.google.cloud.bigtable.data.v2.stub.metrics.BuiltinMetricsConstants;
24+
import com.google.cloud.bigtable.data.v2.stub.metrics.BuiltinMetricsTracerFactory;
25+
import com.google.cloud.bigtable.data.v2.stub.metrics.ChannelPoolMetricsTracer;
26+
import com.google.cloud.bigtable.data.v2.stub.metrics.CompositeTracerFactory;
27+
import com.google.cloud.bigtable.data.v2.stub.metrics.MetricsTracerFactory;
28+
import com.google.cloud.bigtable.data.v2.stub.metrics.RpcMeasureConstants;
29+
import com.google.common.base.Preconditions;
30+
import com.google.common.collect.ImmutableList;
31+
import com.google.common.collect.ImmutableMap;
32+
import io.grpc.ManagedChannelBuilder;
33+
import io.grpc.opentelemetry.GrpcOpenTelemetry;
34+
import io.opencensus.stats.StatsRecorder;
35+
import io.opencensus.tags.TagKey;
36+
import io.opencensus.tags.TagValue;
37+
import io.opencensus.tags.Tagger;
38+
import io.opentelemetry.api.OpenTelemetry;
39+
import io.opentelemetry.sdk.OpenTelemetrySdk;
40+
import java.io.Closeable;
41+
import java.util.ArrayList;
42+
import java.util.List;
43+
import java.util.concurrent.ScheduledExecutorService;
44+
import java.util.concurrent.ScheduledFuture;
45+
import javax.annotation.Nullable;
46+
47+
public class MetricsImpl implements Metrics, Closeable {
48+
private final ApiTracerFactory userTracerFactory;
49+
private final @Nullable OpenTelemetrySdk internalOtel;
50+
private final @Nullable OpenTelemetry userOtel;
51+
private final ScheduledExecutorService executor;
52+
private final Tagger ocTagger;
53+
private final StatsRecorder ocRecorder;
54+
55+
private final GrpcOpenTelemetry grpcOtel;
56+
@Nullable private final ChannelPoolMetricsTracer channelPoolMetricsTracer;
57+
private final List<ScheduledFuture<?>> tasks = new ArrayList<>();
58+
59+
public MetricsImpl(
60+
ApiTracerFactory userTracerFactory,
61+
OpenTelemetrySdk internalOtel,
62+
OpenTelemetry userOtel,
63+
Tagger ocTagger,
64+
StatsRecorder ocRecorder,
65+
ScheduledExecutorService executor) {
66+
this.userTracerFactory = Preconditions.checkNotNull(userTracerFactory);
67+
68+
this.internalOtel = internalOtel;
69+
this.userOtel = userOtel;
70+
71+
this.ocTagger = ocTagger;
72+
this.ocRecorder = ocRecorder;
73+
74+
this.executor = executor;
75+
76+
this.grpcOtel =
77+
GrpcOpenTelemetry.newBuilder()
78+
.sdk(internalOtel)
79+
.addOptionalLabel("grpc.lb.locality")
80+
// Disable default grpc metrics
81+
.disableAllMetrics()
82+
// Enable specific grpc metrics
83+
.enableMetrics(BuiltinMetricsConstants.GRPC_METRICS.keySet())
84+
.build();
85+
86+
if (internalOtel != null) {
87+
this.channelPoolMetricsTracer = new ChannelPoolMetricsTracer(internalOtel);
88+
} else {
89+
this.channelPoolMetricsTracer = null;
90+
}
91+
}
92+
93+
@Override
94+
public void close() {
95+
for (ScheduledFuture<?> task : tasks) {
96+
task.cancel(false);
97+
}
98+
if (internalOtel != null) {
99+
internalOtel.close();
100+
}
101+
}
102+
103+
@Override
104+
public void start() {
105+
tasks.add(channelPoolMetricsTracer.start(executor));
106+
}
107+
108+
@Override
109+
public <T extends ManagedChannelBuilder<?>> T configureGrpcChannel(T channelBuilder) {
110+
grpcOtel.configureChannelBuilder(channelBuilder);
111+
return channelBuilder;
112+
}
113+
114+
@Override
115+
public ApiTracerFactory createTracerFactory(ClientInfo clientInfo) {
116+
ImmutableList.Builder<ApiTracerFactory> tracerFactories = ImmutableList.builder();
117+
tracerFactories
118+
.add(createOCTracingFactory(clientInfo))
119+
.add(createOCMetricsFactory(clientInfo, ocTagger, ocRecorder))
120+
.add(userTracerFactory);
121+
122+
if (internalOtel != null) {
123+
tracerFactories.add(createOtelMetricsFactory(internalOtel, clientInfo));
124+
}
125+
if (userOtel != null) {
126+
tracerFactories.add(createOtelMetricsFactory(userOtel, clientInfo));
127+
}
128+
129+
return new CompositeTracerFactory(tracerFactories.build());
130+
}
131+
132+
@Override
133+
@Nullable
134+
public ChannelPoolMetricsTracer getChannelPoolMetricsTracer() {
135+
return channelPoolMetricsTracer;
136+
}
137+
138+
private static ApiTracerFactory createOCTracingFactory(ClientInfo clientInfo) {
139+
return new OpencensusTracerFactory(
140+
ImmutableMap.<String, String>builder()
141+
// Annotate traces with the same tags as metrics
142+
.put(
143+
RpcMeasureConstants.BIGTABLE_PROJECT_ID.getName(),
144+
clientInfo.getInstanceName().getProject())
145+
.put(
146+
RpcMeasureConstants.BIGTABLE_INSTANCE_ID.getName(),
147+
clientInfo.getInstanceName().getInstance())
148+
.put(
149+
RpcMeasureConstants.BIGTABLE_APP_PROFILE_ID.getName(), clientInfo.getAppProfileId())
150+
// Also annotate traces with library versions
151+
.put("gax", GaxGrpcProperties.getGaxGrpcVersion())
152+
.put("grpc", GaxGrpcProperties.getGrpcVersion())
153+
.put("gapic", Version.VERSION)
154+
.build());
155+
}
156+
157+
private static ApiTracerFactory createOCMetricsFactory(
158+
ClientInfo clientInfo, Tagger tagger, StatsRecorder stats) {
159+
160+
ImmutableMap<TagKey, TagValue> attributes =
161+
ImmutableMap.<TagKey, TagValue>builder()
162+
.put(
163+
RpcMeasureConstants.BIGTABLE_PROJECT_ID,
164+
TagValue.create(clientInfo.getInstanceName().getProject()))
165+
.put(
166+
RpcMeasureConstants.BIGTABLE_INSTANCE_ID,
167+
TagValue.create(clientInfo.getInstanceName().getInstance()))
168+
.put(
169+
RpcMeasureConstants.BIGTABLE_APP_PROFILE_ID,
170+
TagValue.create(clientInfo.getAppProfileId()))
171+
.build();
172+
return MetricsTracerFactory.create(tagger, stats, attributes);
173+
}
174+
175+
private static BuiltinMetricsTracerFactory createOtelMetricsFactory(
176+
OpenTelemetry otel, ClientInfo clientInfo) {
177+
178+
return BuiltinMetricsTracerFactory.create(otel, clientInfo);
179+
}
180+
}

0 commit comments

Comments
 (0)