Skip to content

Commit 878328f

Browse files
committed
chore: warn of disabled metrics
1 parent e0356b4 commit 878328f

2 files changed

Lines changed: 13 additions & 58 deletions

File tree

gax-java/gax/src/main/java/com/google/api/gax/tracing/MetricsTracer.java

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
* Copyright 2024 Google LLC
2+
* Copyright 2026 Google LLC
33
*
44
* Redistribution and use in source and binary forms, with or without
55
* modification, are permitted provided that the following conditions are
@@ -44,6 +44,7 @@
4444
import java.util.concurrent.CancellationException;
4545
import java.util.concurrent.TimeUnit;
4646
import java.util.concurrent.atomic.AtomicBoolean;
47+
import java.util.logging.Logger;
4748
import javax.annotation.Nullable;
4849

4950
/**
@@ -55,6 +56,9 @@
5556
@BetaApi
5657
@InternalApi
5758
public class MetricsTracer implements ApiTracer {
59+
private static final Logger LOGGER = Logger.getLogger(MetricsTracer.class.getName());
60+
private static final AtomicBoolean WARNING_LOGGED = new AtomicBoolean();
61+
5862
public static final String METHOD_ATTRIBUTE = "method";
5963
public static final String LANGUAGE_ATTRIBUTE = "language";
6064
public static final String STATUS_ATTRIBUTE = "status";
@@ -69,6 +73,14 @@ public class MetricsTracer implements ApiTracer {
6973
private final AtomicBoolean operationFinished;
7074

7175
public MetricsTracer(MethodName methodName, MetricsRecorder metricsRecorder) {
76+
if (!MetricsUtils.isMetricsEnabled()) {
77+
if (WARNING_LOGGED.compareAndSet(false, true)) {
78+
LOGGER.info(
79+
"Metrics are currently disabled. To enable metrics, set the environment variable "
80+
+ "GOOGLE_CLOUD_ENABLE_METRICS=true or the system property "
81+
+ "GOOGLE_CLOUD_ENABLE_METRICS=true.");
82+
}
83+
}
7284
this.attributes.put(METHOD_ATTRIBUTE, methodName.toString());
7385
this.attributes.put(LANGUAGE_ATTRIBUTE, DEFAULT_LANGUAGE);
7486
this.metricsRecorder = metricsRecorder;

gax-java/gax/src/test/java/com/google/api/gax/tracing/MetricsUtilsTest.java

Lines changed: 0 additions & 57 deletions
This file was deleted.

0 commit comments

Comments
 (0)