com.google.cloud.spanner.SpannerCloudMonitoringExporter Maven / Gradle / Ivy
Show all versions of google-cloud-spanner Show documentation
/*
* 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;
import static com.google.cloud.spanner.BuiltInMetricsConstant.SPANNER_METRICS;
import com.google.api.core.ApiFuture;
import com.google.api.core.ApiFutureCallback;
import com.google.api.core.ApiFutures;
import com.google.api.gax.core.CredentialsProvider;
import com.google.api.gax.core.FixedCredentialsProvider;
import com.google.api.gax.core.NoCredentialsProvider;
import com.google.api.gax.rpc.PermissionDeniedException;
import com.google.auth.Credentials;
import com.google.cloud.monitoring.v3.MetricServiceClient;
import com.google.cloud.monitoring.v3.MetricServiceSettings;
import com.google.common.annotations.VisibleForTesting;
import com.google.common.base.MoreObjects;
import com.google.common.collect.Iterables;
import com.google.common.util.concurrent.MoreExecutors;
import com.google.monitoring.v3.CreateTimeSeriesRequest;
import com.google.monitoring.v3.ProjectName;
import com.google.monitoring.v3.TimeSeries;
import com.google.protobuf.Empty;
import io.opentelemetry.sdk.common.CompletableResultCode;
import io.opentelemetry.sdk.metrics.InstrumentType;
import io.opentelemetry.sdk.metrics.data.AggregationTemporality;
import io.opentelemetry.sdk.metrics.data.MetricData;
import io.opentelemetry.sdk.metrics.export.MetricExporter;
import java.io.IOException;
import java.util.ArrayList;
import java.util.Collection;
import java.util.List;
import java.util.concurrent.atomic.AtomicBoolean;
import java.util.logging.Level;
import java.util.logging.Logger;
import java.util.stream.Collectors;
import javax.annotation.Nullable;
import org.threeten.bp.Duration;
/**
* Spanner Cloud Monitoring OpenTelemetry Exporter.
*
* The exporter will look for all spanner owned metrics under spanner.googleapis.com
* instrumentation scope and upload it via the Google Cloud Monitoring API.
*/
class SpannerCloudMonitoringExporter implements MetricExporter {
private static final Logger logger =
Logger.getLogger(SpannerCloudMonitoringExporter.class.getName());
// This system property can be used to override the monitoring endpoint
// to a different environment. It's meant for internal testing only.
private static final String MONITORING_ENDPOINT =
MoreObjects.firstNonNull(
System.getProperty("spanner.test-monitoring-endpoint"),
MetricServiceSettings.getDefaultEndpoint());
// This the quota limit from Cloud Monitoring. More details in
// https://cloud.google.com/monitoring/quotas#custom_metrics_quotas.
private static final int EXPORT_BATCH_SIZE_LIMIT = 200;
private final AtomicBoolean spannerExportFailureLogged = new AtomicBoolean(false);
private CompletableResultCode lastExportCode;
private final MetricServiceClient client;
private final String spannerProjectId;
static SpannerCloudMonitoringExporter create(String projectId, @Nullable Credentials credentials)
throws IOException {
MetricServiceSettings.Builder settingsBuilder = MetricServiceSettings.newBuilder();
CredentialsProvider credentialsProvider;
if (credentials == null) {
credentialsProvider = NoCredentialsProvider.create();
} else {
credentialsProvider = FixedCredentialsProvider.create(credentials);
}
settingsBuilder.setCredentialsProvider(credentialsProvider);
settingsBuilder.setEndpoint(MONITORING_ENDPOINT);
org.threeten.bp.Duration timeout = Duration.ofMinutes(1);
// TODO: createServiceTimeSeries needs special handling if the request failed. Leaving
// it as not retried for now.
settingsBuilder.createServiceTimeSeriesSettings().setSimpleTimeoutNoRetries(timeout);
return new SpannerCloudMonitoringExporter(
projectId, MetricServiceClient.create(settingsBuilder.build()));
}
@VisibleForTesting
SpannerCloudMonitoringExporter(String projectId, MetricServiceClient client) {
this.client = client;
this.spannerProjectId = projectId;
}
@Override
public CompletableResultCode export(Collection collection) {
if (client.isShutdown()) {
logger.log(Level.WARNING, "Exporter is shut down");
return CompletableResultCode.ofFailure();
}
this.lastExportCode = exportSpannerClientMetrics(collection);
return lastExportCode;
}
/** Export client built in metrics */
private CompletableResultCode exportSpannerClientMetrics(Collection collection) {
// Filter spanner metrics
List spannerMetricData =
collection.stream()
.filter(md -> SPANNER_METRICS.contains(md.getName()))
.collect(Collectors.toList());
// Skips exporting if there's none
if (spannerMetricData.isEmpty()) {
return CompletableResultCode.ofSuccess();
}
// Verifies metrics project id is the same as the spanner project id set on this client
if (!spannerMetricData.stream()
.flatMap(metricData -> metricData.getData().getPoints().stream())
.allMatch(
pd -> spannerProjectId.equals(SpannerCloudMonitoringExporterUtils.getProjectId(pd)))) {
logger.log(Level.WARNING, "Metric data has a different projectId. Skipping export.");
return CompletableResultCode.ofFailure();
}
List spannerTimeSeries;
try {
spannerTimeSeries =
SpannerCloudMonitoringExporterUtils.convertToSpannerTimeSeries(spannerMetricData);
} catch (Throwable e) {
logger.log(
Level.WARNING,
"Failed to convert spanner metric data to cloud monitoring timeseries.",
e);
return CompletableResultCode.ofFailure();
}
ProjectName projectName = ProjectName.of(spannerProjectId);
ApiFuture> futureList = exportTimeSeriesInBatch(projectName, spannerTimeSeries);
CompletableResultCode spannerExportCode = new CompletableResultCode();
ApiFutures.addCallback(
futureList,
new ApiFutureCallback>() {
@Override
public void onFailure(Throwable throwable) {
if (spannerExportFailureLogged.compareAndSet(false, true)) {
String msg = "createServiceTimeSeries request failed for spanner metrics.";
if (throwable instanceof PermissionDeniedException) {
// TODO: Add the link of public documentation when available in the log message.
msg +=
String.format(
" Need monitoring metric writer permission on project=%s.",
projectName.getProject());
}
logger.log(Level.WARNING, msg, throwable);
}
spannerExportCode.fail();
}
@Override
public void onSuccess(List empty) {
// When an export succeeded reset the export failure flag to false so if there's a
// transient failure it'll be logged.
spannerExportFailureLogged.set(false);
spannerExportCode.succeed();
}
},
MoreExecutors.directExecutor());
return spannerExportCode;
}
private ApiFuture> exportTimeSeriesInBatch(
ProjectName projectName, List timeSeries) {
List> batchResults = new ArrayList<>();
for (List batch : Iterables.partition(timeSeries, EXPORT_BATCH_SIZE_LIMIT)) {
CreateTimeSeriesRequest req =
CreateTimeSeriesRequest.newBuilder()
.setName(projectName.toString())
.addAllTimeSeries(batch)
.build();
batchResults.add(this.client.createServiceTimeSeriesCallable().futureCall(req));
}
return ApiFutures.allAsList(batchResults);
}
@Override
public CompletableResultCode flush() {
return CompletableResultCode.ofSuccess();
}
@Override
public CompletableResultCode shutdown() {
if (client.isShutdown()) {
logger.log(Level.WARNING, "shutdown is called multiple times");
return CompletableResultCode.ofSuccess();
}
CompletableResultCode shutdownResult = new CompletableResultCode();
try {
client.shutdown();
shutdownResult.succeed();
} catch (Throwable e) {
logger.log(Level.WARNING, "failed to shutdown the monitoring client", e);
shutdownResult.fail();
}
return shutdownResult;
}
/**
* For Google Cloud Monitoring always return CUMULATIVE to keep track of the cumulative value of a
* metric over time.
*/
@Override
public AggregationTemporality getAggregationTemporality(InstrumentType instrumentType) {
return AggregationTemporality.CUMULATIVE;
}
}