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

Commit b84ff59

Browse files
chore: start pulling all metrics related things together under Metric… (#2807)
…sImpl Change-Id: I78a5d0fed976381bd952ca405c36ce22e8c6178f Thank you for opening a Pull Request! Before submitting your PR, there are a few things you can do to make sure it goes smoothly: - [ ] Make sure to open an issue as a [bug/issue](https://togithub.com/googleapis/java-bigtable/issues/new/choose) before writing your code! That way we can discuss the change, evaluate designs, and agree on the general idea - [ ] Ensure the tests and linter pass - [ ] Code coverage does not decrease (if any source code was changed) - [ ] Appropriate docs were updated (if necessary) - [ ] Rollback plan is reviewed and LGTMed - [ ] All new data plane features have a completed end to end testing plan Fixes #<issue_number_goes_here> ☕️ If you write sample code, please follow the [samples format]( https://togithub.com/GoogleCloudPlatform/java-docs-samples/blob/main/SAMPLE_FORMAT.md).
1 parent be51db4 commit b84ff59

6 files changed

Lines changed: 308 additions & 203 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: 236 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,236 @@
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.auth.Credentials;
22+
import com.google.cloud.bigtable.Version;
23+
import com.google.cloud.bigtable.data.v2.BigtableDataSettings;
24+
import com.google.cloud.bigtable.data.v2.internal.csm.attributes.ClientInfo;
25+
import com.google.cloud.bigtable.data.v2.stub.metrics.BigtableCloudMonitoringExporter;
26+
import com.google.cloud.bigtable.data.v2.stub.metrics.BuiltinMetricsConstants;
27+
import com.google.cloud.bigtable.data.v2.stub.metrics.BuiltinMetricsTracerFactory;
28+
import com.google.cloud.bigtable.data.v2.stub.metrics.ChannelPoolMetricsTracer;
29+
import com.google.cloud.bigtable.data.v2.stub.metrics.CompositeTracerFactory;
30+
import com.google.cloud.bigtable.data.v2.stub.metrics.MetricsTracerFactory;
31+
import com.google.cloud.bigtable.data.v2.stub.metrics.RpcMeasureConstants;
32+
import com.google.common.base.Preconditions;
33+
import com.google.common.collect.ImmutableList;
34+
import com.google.common.collect.ImmutableMap;
35+
import io.grpc.ManagedChannelBuilder;
36+
import io.grpc.opentelemetry.GrpcOpenTelemetry;
37+
import io.opencensus.stats.StatsRecorder;
38+
import io.opencensus.tags.TagKey;
39+
import io.opencensus.tags.TagValue;
40+
import io.opencensus.tags.Tagger;
41+
import io.opentelemetry.api.OpenTelemetry;
42+
import io.opentelemetry.sdk.OpenTelemetrySdk;
43+
import io.opentelemetry.sdk.metrics.InstrumentSelector;
44+
import io.opentelemetry.sdk.metrics.SdkMeterProvider;
45+
import io.opentelemetry.sdk.metrics.SdkMeterProviderBuilder;
46+
import io.opentelemetry.sdk.metrics.View;
47+
import io.opentelemetry.sdk.metrics.export.MetricExporter;
48+
import io.opentelemetry.sdk.metrics.export.PeriodicMetricReader;
49+
import io.opentelemetry.sdk.metrics.export.PeriodicMetricReaderBuilder;
50+
import java.io.Closeable;
51+
import java.io.IOException;
52+
import java.util.ArrayList;
53+
import java.util.List;
54+
import java.util.Map;
55+
import java.util.concurrent.ScheduledExecutorService;
56+
import java.util.concurrent.ScheduledFuture;
57+
import javax.annotation.Nullable;
58+
59+
public class MetricsImpl implements Metrics, Closeable {
60+
private final ApiTracerFactory userTracerFactory;
61+
private final @Nullable OpenTelemetrySdk internalOtel;
62+
private final @Nullable OpenTelemetry userOtel;
63+
private final ScheduledExecutorService executor;
64+
private final Tagger ocTagger;
65+
private final StatsRecorder ocRecorder;
66+
67+
@Nullable private final GrpcOpenTelemetry grpcOtel;
68+
@Nullable private final ChannelPoolMetricsTracer channelPoolMetricsTracer;
69+
private final List<ScheduledFuture<?>> tasks = new ArrayList<>();
70+
71+
public MetricsImpl(
72+
ApiTracerFactory userTracerFactory,
73+
@Nullable OpenTelemetrySdk internalOtel,
74+
@Nullable OpenTelemetry userOtel,
75+
Tagger ocTagger,
76+
StatsRecorder ocRecorder,
77+
ScheduledExecutorService executor) {
78+
this.userTracerFactory = Preconditions.checkNotNull(userTracerFactory);
79+
80+
this.internalOtel = internalOtel;
81+
this.userOtel = userOtel;
82+
83+
this.ocTagger = ocTagger;
84+
this.ocRecorder = ocRecorder;
85+
86+
this.executor = executor;
87+
88+
if (internalOtel != null) {
89+
this.grpcOtel =
90+
GrpcOpenTelemetry.newBuilder()
91+
.sdk(internalOtel)
92+
.addOptionalLabel("grpc.lb.locality")
93+
// Disable default grpc metrics
94+
.disableAllMetrics()
95+
// Enable specific grpc metrics
96+
.enableMetrics(BuiltinMetricsConstants.GRPC_METRICS.keySet())
97+
.build();
98+
} else {
99+
this.grpcOtel = null;
100+
}
101+
102+
if (internalOtel != null) {
103+
this.channelPoolMetricsTracer = new ChannelPoolMetricsTracer(internalOtel);
104+
} else {
105+
this.channelPoolMetricsTracer = null;
106+
}
107+
}
108+
109+
@Override
110+
public void close() {
111+
for (ScheduledFuture<?> task : tasks) {
112+
task.cancel(false);
113+
}
114+
if (internalOtel != null) {
115+
internalOtel.close();
116+
}
117+
}
118+
119+
@Override
120+
public void start() {
121+
if (channelPoolMetricsTracer != null) {
122+
tasks.add(channelPoolMetricsTracer.start(executor));
123+
}
124+
}
125+
126+
@Override
127+
public <T extends ManagedChannelBuilder<?>> T configureGrpcChannel(T channelBuilder) {
128+
if (grpcOtel == null) {
129+
return channelBuilder;
130+
}
131+
grpcOtel.configureChannelBuilder(channelBuilder);
132+
return channelBuilder;
133+
}
134+
135+
@Override
136+
public ApiTracerFactory createTracerFactory(ClientInfo clientInfo) {
137+
ImmutableList.Builder<ApiTracerFactory> tracerFactories = ImmutableList.builder();
138+
tracerFactories
139+
.add(createOCTracingFactory(clientInfo))
140+
.add(createOCMetricsFactory(clientInfo, ocTagger, ocRecorder))
141+
.add(userTracerFactory);
142+
143+
if (internalOtel != null) {
144+
tracerFactories.add(createOtelMetricsFactory(internalOtel, clientInfo));
145+
}
146+
if (userOtel != null) {
147+
tracerFactories.add(createOtelMetricsFactory(userOtel, clientInfo));
148+
}
149+
150+
return new CompositeTracerFactory(tracerFactories.build());
151+
}
152+
153+
@Override
154+
@Nullable
155+
public ChannelPoolMetricsTracer getChannelPoolMetricsTracer() {
156+
return channelPoolMetricsTracer;
157+
}
158+
159+
public static OpenTelemetrySdk createBuiltinOtel(
160+
ClientInfo clientInfo,
161+
@Nullable Credentials defaultCredentials,
162+
@Nullable String metricsEndpoint,
163+
String universeDomain,
164+
ScheduledExecutorService executor)
165+
throws IOException {
166+
167+
Credentials credentials =
168+
BigtableDataSettings.getMetricsCredentials() != null
169+
? BigtableDataSettings.getMetricsCredentials()
170+
: defaultCredentials;
171+
172+
SdkMeterProviderBuilder meterProvider = SdkMeterProvider.builder();
173+
174+
for (Map.Entry<InstrumentSelector, View> entry :
175+
BuiltinMetricsConstants.getAllViews().entrySet()) {
176+
meterProvider.registerView(entry.getKey(), entry.getValue());
177+
}
178+
179+
for (Map.Entry<InstrumentSelector, View> e :
180+
BuiltinMetricsConstants.getInternalViews().entrySet()) {
181+
meterProvider.registerView(e.getKey(), e.getValue());
182+
}
183+
184+
MetricExporter publicExporter =
185+
BigtableCloudMonitoringExporter.create(
186+
clientInfo, credentials, metricsEndpoint, universeDomain, executor);
187+
PeriodicMetricReaderBuilder readerBuilder =
188+
PeriodicMetricReader.builder(publicExporter).setExecutor(executor);
189+
meterProvider.registerMetricReader(readerBuilder.build());
190+
191+
return OpenTelemetrySdk.builder().setMeterProvider(meterProvider.build()).build();
192+
}
193+
194+
private static ApiTracerFactory createOCTracingFactory(ClientInfo clientInfo) {
195+
return new OpencensusTracerFactory(
196+
ImmutableMap.<String, String>builder()
197+
// Annotate traces with the same tags as metrics
198+
.put(
199+
RpcMeasureConstants.BIGTABLE_PROJECT_ID.getName(),
200+
clientInfo.getInstanceName().getProject())
201+
.put(
202+
RpcMeasureConstants.BIGTABLE_INSTANCE_ID.getName(),
203+
clientInfo.getInstanceName().getInstance())
204+
.put(
205+
RpcMeasureConstants.BIGTABLE_APP_PROFILE_ID.getName(), clientInfo.getAppProfileId())
206+
// Also annotate traces with library versions
207+
.put("gax", GaxGrpcProperties.getGaxGrpcVersion())
208+
.put("grpc", GaxGrpcProperties.getGrpcVersion())
209+
.put("gapic", Version.VERSION)
210+
.build());
211+
}
212+
213+
private static ApiTracerFactory createOCMetricsFactory(
214+
ClientInfo clientInfo, Tagger tagger, StatsRecorder stats) {
215+
216+
ImmutableMap<TagKey, TagValue> attributes =
217+
ImmutableMap.<TagKey, TagValue>builder()
218+
.put(
219+
RpcMeasureConstants.BIGTABLE_PROJECT_ID,
220+
TagValue.create(clientInfo.getInstanceName().getProject()))
221+
.put(
222+
RpcMeasureConstants.BIGTABLE_INSTANCE_ID,
223+
TagValue.create(clientInfo.getInstanceName().getInstance()))
224+
.put(
225+
RpcMeasureConstants.BIGTABLE_APP_PROFILE_ID,
226+
TagValue.create(clientInfo.getAppProfileId()))
227+
.build();
228+
return MetricsTracerFactory.create(tagger, stats, attributes);
229+
}
230+
231+
private static BuiltinMetricsTracerFactory createOtelMetricsFactory(
232+
OpenTelemetry otel, ClientInfo clientInfo) {
233+
234+
return BuiltinMetricsTracerFactory.create(otel, clientInfo);
235+
}
236+
}

0 commit comments

Comments
 (0)