com.google.cloud.spanner.jdbc.Metrics Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of google-cloud-spanner-jdbc Show documentation

JDBC driver for Google Cloud Spanner.

There is a newer version: 2.25.2

Show newest version

/*
 * Copyright 2024 Google LLC
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *       http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package com.google.cloud.spanner.jdbc;

import io.opentelemetry.api.OpenTelemetry;
import io.opentelemetry.api.common.Attributes;
import io.opentelemetry.api.metrics.LongHistogram;
import io.opentelemetry.api.metrics.Meter;
import java.util.Arrays;
import java.util.List;

class Metrics {
  static final String INSTRUMENTATION_SCOPE = "cloud.google.com/java";
  static final String SPANNER_CLIENT_LIB_LATENCY = "spanner/jdbc/client_lib_latencies";
  static final String SPANNER_CLIENT_LIB_LATENCY_DESCRIPTION =
      "Latency when the client library receives a call and returns a response";

  private final LongHistogram spannerClientLibLatencies;

  Metrics(OpenTelemetry openTelemetry) {
    Meter meter = openTelemetry.getMeter(INSTRUMENTATION_SCOPE);
    List RPC_MILLIS_BUCKET_BOUNDARIES =
        Arrays.asList(
            1L, 2L, 3L, 4L, 5L, 6L, 8L, 10L, 13L, 16L, 20L, 25L, 30L, 40L, 50L, 65L, 80L, 100L,
            130L, 160L, 200L, 250L, 300L, 400L, 500L, 650L, 800L, 1000L, 2000L, 5000L, 10000L,
            20000L, 50000L, 100000L);
    spannerClientLibLatencies =
        meter
            .histogramBuilder(SPANNER_CLIENT_LIB_LATENCY)
            .ofLongs()
            .setDescription(SPANNER_CLIENT_LIB_LATENCY_DESCRIPTION)
            .setUnit("ms")
            .setExplicitBucketBoundariesAdvice(RPC_MILLIS_BUCKET_BOUNDARIES)
            .build();
  }

  void recordClientLibLatency(long value, Attributes attributes) {
    spannerClientLibLatencies.record(value, attributes);
  }
}