fix: provide option to disable built in metrics (#2380)

* fix: provide option to disable built in metrics

* fix: provide option to disable built in metrics

* 🦉 Updates from OwlBot post-processor

See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md

* 🦉 Updates from OwlBot post-processor

See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md

* review comments

* changed isEmulator variable to isInSecureCredentials

---------

Co-authored-by: Owl Bot <gcf-owl-bot[bot]@users.noreply.github.com>

Author: surbhigarg92

.github/workflows/ci.yaml

@@ -11,7 +11,7 @@ jobs:
       matrix:
         node: [18, 20, 22, 24]
     steps:
-      - uses: actions/checkout@v5
+      - uses: actions/checkout@v4
       - uses: actions/setup-node@v4
         with:
           node-version: ${{ matrix.node }}
@@ -29,7 +29,7 @@ jobs:
   test-script:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v5
+      - uses: actions/checkout@v4
       - uses: actions/setup-node@v4
         with:
           node-version: 18
@@ -43,7 +43,7 @@ jobs:
   windows:
     runs-on: windows-latest
     steps:
-      - uses: actions/checkout@v5
+      - uses: actions/checkout@v4
       - uses: actions/setup-node@v4
         with:
           node-version: 18
@@ -54,7 +54,7 @@ jobs:
   lint:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v5
+      - uses: actions/checkout@v4
       - uses: actions/setup-node@v4
         with:
           node-version: 18
@@ -63,7 +63,7 @@ jobs:
   docs:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v5
+      - uses: actions/checkout@v4
       - uses: actions/setup-node@v4
         with:
           node-version: 18

.github/workflows/issues-no-repro.yaml

@@ -10,7 +10,7 @@ jobs:
       issues: write
       pull-requests: write
     steps:
-      - uses: actions/checkout@v5
+      - uses: actions/checkout@v4
       - uses: actions/setup-node@v4
         with:
           node-version: 18

.github/workflows/response.yaml

@@ -13,7 +13,7 @@ jobs:
       issues: write
       pull-requests: write
     steps:
-      - uses: actions/checkout@v5
+      - uses: actions/checkout@v4
       - uses: actions/github-script@v7
         with:
           script: |
@@ -27,7 +27,7 @@ jobs:
       issues: write
       pull-requests: write
     steps:
-      - uses: actions/checkout@v5
+      - uses: actions/checkout@v4
       - uses: actions/github-script@v7
         with:
           script: |

src/index.ts

@@ -150,6 +150,7 @@ export type GetInstanceConfigOperationsCallback = PagedCallback<
  * Indicates which replicas or regions should be used for non-transactional reads or queries.
  * DirectedReadOptions won't be set for readWrite transactions"
  * @property {ObservabilityOptions} [observabilityOptions] Sets the observability options to be used for OpenTelemetry tracing
+ * @property {boolean} [disableBuiltInMetrics=True] If set to true, built-in metrics will be disabled.
  */
 export interface SpannerOptions extends GrpcClientOptions {
   apiEndpoint?: string;
@@ -160,6 +161,7 @@ export interface SpannerOptions extends GrpcClientOptions {
   directedReadOptions?: google.spanner.v1.IDirectedReadOptions | null;
   defaultTransactionOptions?: Pick<RunTransactionOptions, 'isolationLevel'>;
   observabilityOptions?: ObservabilityOptions;
+  disableBuiltInMetrics?: boolean;
   interceptors?: any[];
   /**
    * The Trusted Cloud Domain (TPC) DNS of the service used to make requests.
@@ -315,7 +317,7 @@ class Spanner extends GrpcService {
   defaultTransactionOptions: RunTransactionOptions;
   _observabilityOptions: ObservabilityOptions | undefined;
   private _universeDomain: string;
-  private _isEmulatorEnabled: boolean;
+  private _isInSecureCredentials: boolean;
   private static _isAFEServerTimingEnabled: boolean | undefined;
   readonly _nthClientId: number;
 
@@ -443,14 +445,12 @@ class Spanner extends GrpcService {
       );
     }
 
-    let isEmulatorEnabled = false;
     const emulatorHost = Spanner.getSpannerEmulatorHost();
     if (
       emulatorHost &&
       emulatorHost.endpoint &&
       emulatorHost.endpoint.length > 0
     ) {
-      isEmulatorEnabled = true;
       options.servicePath = emulatorHost.endpoint;
       options.port = emulatorHost.port;
       options.sslCreds = grpc.credentials.createInsecure();
@@ -477,7 +477,7 @@ class Spanner extends GrpcService {
       this.routeToLeaderEnabled = false;
     }
 
-    this._isEmulatorEnabled = isEmulatorEnabled;
+    this._isInSecureCredentials = options.sslCreds?._isSecure() === false;
     this.options = options;
     this.auth = new GoogleAuth(this.options);
     this.clients_ = new Map();
@@ -495,7 +495,7 @@ class Spanner extends GrpcService {
     ensureInitialContextManagerSet();
     this._nthClientId = nextSpannerClientId();
     this._universeDomain = universeEndpoint;
-    this.configureMetrics_();
+    this.configureMetrics_(options.disableBuiltInMetrics);
   }
 
   get universeDomain() {
@@ -1614,10 +1614,11 @@ class Spanner extends GrpcService {
   /**
    * Setup the OpenTelemetry metrics capturing for service metrics to Google Cloud Monitoring.
    */
-  configureMetrics_() {
+  configureMetrics_(disableBuiltInMetrics?: boolean) {
     const metricsEnabled =
       process.env.SPANNER_DISABLE_BUILTIN_METRICS !== 'true' &&
-      !this._isEmulatorEnabled;
+      !disableBuiltInMetrics &&
+      !this._isInSecureCredentials;
     MetricsTracerFactory.enabled = metricsEnabled;
     if (metricsEnabled) {
       const factory = MetricsTracerFactory.getInstance(this.projectId);

test/index.ts

@@ -327,6 +327,12 @@ describe('Spanner', () => {
       assert.strictEqual(spanner.routeToLeaderEnabled, false);
     });
 
+    it('should optionally accept disableBuiltInMetrics', () => {
+      const spanner = new Spanner({disableBuiltInMetrics: true});
+      assert.strictEqual(MetricsTracerFactory.enabled, false);
+      MetricsTracerFactory.enabled = true; // Reset for other tests.
+    });
+
     it('should optionally accept directedReadOptions', () => {
       const fakeDirectedReadOptions = {
         includeReplicas: {

test/metrics/metrics.ts

@@ -209,6 +209,7 @@ describe('Test metrics with mock server', () => {
       spannerMock.resetRequests();
       spannerMock.removeExecutionTimes();
       // Reset the MetricsFactoryReader to an in-memory reader for the tests
+      MetricsTracerFactory.enabled = true;
       factory = MetricsTracerFactory.getInstance();
       await factory!.resetMeterProvider();
       reader = new InMemoryMetricReader();