Skip to content

fix: fix exporting grpc metrics #13376

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.

Sign up for GitHub

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

Merged
mutianf merged 2 commits into from
Jun 5, 2026
+43 −3
Merged

fix: fix exporting grpc metrics #13376

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
63ef490
fix: fix exporting grpc metrics
mutianf Jun 5, 2026
2698a80
add a test and reformat
mutianf Jun 5, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 9 additions & 2 deletions ...ud-bigtable/src/main/java/com/google/cloud/bigtable/data/v2/internal/csm/MetricsImpl.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -87,6 +87,7 @@
public class MetricsImpl implements Metrics, Closeable {

public static final String CUSTOM_METRIC = "bigtable.internal.enable-custom-metric";
public static final String CUSTOM_METRIC_PREFIX = "bigtable.custom";

private static final boolean enableCustomMetric =
Optional.ofNullable(System.getProperty(CUSTOM_METRIC))
Expand Down Expand Up @@ -319,7 +320,13 @@ public static OpenTelemetrySdk createBuiltinOtel(
new BigtablePeriodicReader(
new BigtableFilteringExporter(
exporter,
input -> input.getName().startsWith("bigtable.googleapis.com/internal/client")),
input -> {
// filter out custom metrics and keep everything else that's registered on metric
// registry
String name = input.getName();
return metricRegistry.getMetric(name) != null
&& !name.startsWith(CUSTOM_METRIC_PREFIX);
}),
Comment on lines +323 to +329
Copy link
Copy Markdown
Contributor

@gemini-code-assist gemini-code-assist Bot Jun 5, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

high

The current filter only allows metrics that are registered in metricRegistry. Since gRPC metrics (which typically start with grpc.) are registered directly by the gRPC library and are not present in metricRegistry, they will be filtered out and not exported. To fix this, explicitly allow metrics starting with grpc. in the filter.

Suggested change
input -> {
String name = input.getName();
return metricRegistry.getMetric(name) != null
&& !name.startsWith(CUSTOM_METRIC_PREFIX);
}),
input -> {
String name = input.getName();
return (metricRegistry.getMetric(name) != null || name.startsWith("grpc."))
&& !name.startsWith(CUSTOM_METRIC_PREFIX);
}),

Copy link
Copy Markdown
Contributor Author

@mutianf mutianf Jun 5, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think this is true. Grpc metrics are registered: https://github.com/googleapis/google-cloud-java/blob/main/java-bigtable/google-cloud-bigtable/src/main/java/com/google/cloud/bigtable/data/v2/internal/csm/MetricRegistry.java#L127

executor));

if (enableCustomMetric) {
Expand All @@ -333,7 +340,7 @@ public static OpenTelemetrySdk createBuiltinOtel(
PeriodicMetricReader.builder(
new BigtableFilteringExporter(
GoogleCloudMetricExporter.createWithConfiguration(metricConfig),
input -> input.getName().startsWith("bigtable.custom")))
input -> input.getName().startsWith(CUSTOM_METRIC_PREFIX)))
.setInterval(Duration.ofMinutes(1))
.build());
}
Expand Down
3 changes: 2 additions & 1 deletion ...ain/java/com/google/cloud/bigtable/data/v2/internal/csm/metrics/CustomAttemptLatency.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@

import com.google.bigtable.v2.ClusterInformation;
import com.google.bigtable.v2.PeerInfo;
import com.google.cloud.bigtable.data.v2.internal.csm.MetricsImpl;
import com.google.cloud.bigtable.data.v2.internal.csm.attributes.ClientInfo;
import com.google.cloud.bigtable.data.v2.internal.csm.attributes.MethodInfo;
import com.google.cloud.bigtable.data.v2.internal.csm.attributes.Util;
Expand All @@ -33,7 +34,7 @@
* exported as a custom metric.
*/
public class CustomAttemptLatency extends MetricWrapper<CustomSchema> {
private static final String NAME = "bigtable.custom.attempt_latencies";
private static final String NAME = MetricsImpl.CUSTOM_METRIC_PREFIX + ".attempt_latencies";

public CustomAttemptLatency() {
super(CustomSchema.INSTANCE, NAME);
Expand Down
32 changes: 32 additions & 0 deletions ...rc/test/java/com/google/cloud/bigtable/data/v2/internal/csm/MetricRegistryExportTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -775,6 +775,38 @@ void testPacemaker() {
.build());
}

@Test
void testGrpcMetricExport() {
// 1. Record a gRPC metric using its internal name
// Note: gRPC metrics are usually recorded by gRPC-Java's OpenTelemetry integration,
// but we can simulate it by getting the instrument from the meter directly.
meterProvider
.get("grpc-java")
.histogramBuilder("grpc.client.attempt.duration")
.build()
.record(
123.0,
io.opentelemetry.api.common.Attributes.of(
io.opentelemetry.api.common.AttributeKey.stringKey("grpc.status"), "OK",
io.opentelemetry.api.common.AttributeKey.stringKey("grpc.method"),
"Bigtable.ReadRows"));

// 2. Flush the metrics to the exporter
metricReader.forceFlush().join(1, TimeUnit.MINUTES);

// 3. Verify that the metric was exported under the Bigtable namespace
// The internal 'grpc.client.attempt.duration' should be renamed by GrpcMetric.java
TimeSeries timeSeries =
metricService.getSingleTimeSeriesByName(
"bigtable.googleapis.com/internal/client/grpc/client/attempt/duration");

// 4. Verify labels are correctly mapped (dots replaced with underscores)
assertThat(timeSeries.getMetric().getLabelsMap())
.containsAtLeast(
"grpc_status", "OK",
"grpc_method", "Bigtable.ReadRows");
}

private static class FakeMetricService extends MetricServiceImplBase {
final BlockingDeque<CreateTimeSeriesRequest> requests = new LinkedBlockingDeque<>();

Expand Down
Loading