-
Notifications
You must be signed in to change notification settings - Fork 123
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Adding gfe_latencies metric to built-in metrics
- Loading branch information
1 parent
ea1ebad
commit 7383362
Showing
8 changed files
with
205 additions
and
36 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
88 changes: 88 additions & 0 deletions
88
...d-spanner/src/main/java/com/google/cloud/spanner/BuiltInOpenTelemetryMetricsRecorder.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,88 @@ | ||
| /* | ||
| * 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 com.google.api.gax.core.GaxProperties; | ||
| import com.google.common.annotations.VisibleForTesting; | ||
| import com.google.common.base.Preconditions; | ||
| import io.opentelemetry.api.OpenTelemetry; | ||
| import io.opentelemetry.api.common.Attributes; | ||
| import io.opentelemetry.api.common.AttributesBuilder; | ||
| import io.opentelemetry.api.metrics.DoubleHistogram; | ||
| import io.opentelemetry.api.metrics.Meter; | ||
| import java.util.HashMap; | ||
| import java.util.Map; | ||
|
|
||
| /** OpenTelemetry implementation of recording built in metrics. */ | ||
| public class BuiltInOpenTelemetryMetricsRecorder { | ||
|
|
||
| private final DoubleHistogram gfeLatencyRecorder; | ||
| private final Map<String, String> attributes = new HashMap<>(); | ||
|
|
||
| /** | ||
| * Creates the following instruments for the following metrics: | ||
| * | ||
| * <ul> | ||
| * <li>GFE Latency: Histogram | ||
| * </ul> | ||
| * | ||
| * @param openTelemetry OpenTelemetry instance | ||
| */ | ||
| public BuiltInOpenTelemetryMetricsRecorder( | ||
| OpenTelemetry openTelemetry, Map<String, String> clientAttributes) { | ||
| if (openTelemetry != null && clientAttributes != null) { | ||
| gfeLatencyRecorder = null; | ||
| return; | ||
| } | ||
| Meter meter = | ||
| openTelemetry | ||
| .meterBuilder(BuiltInMetricsConstant.SPANNER_METER_NAME) | ||
| .setInstrumentationVersion(GaxProperties.getLibraryVersion(getClass())) | ||
| .build(); | ||
| this.gfeLatencyRecorder = | ||
| meter | ||
| .histogramBuilder( | ||
| BuiltInMetricsConstant.METER_NAME + '/' + BuiltInMetricsConstant.GFE_LATENCIES_NAME) | ||
| .setDescription( | ||
| "Latency between Google's network receiving an RPC and reading back the first byte of the response") | ||
| .setUnit("ms") | ||
| .build(); | ||
| this.attributes.putAll(clientAttributes); | ||
| } | ||
|
|
||
| /** | ||
| * Record the latency between Google's network receiving an RPC and reading back the first byte of | ||
| * the response. Data is stored in a Histogram. | ||
| * | ||
| * @param gfeLatency Attempt Latency in ms | ||
| * @param attributes Map of the attributes to store | ||
| */ | ||
| public void recordGFELatency(double gfeLatency, Map<String, String> attributes) { | ||
| if (gfeLatencyRecorder != null) { | ||
| this.attributes.putAll(attributes); | ||
| gfeLatencyRecorder.record(gfeLatency, toOtelAttributes(this.attributes)); | ||
| } | ||
| } | ||
|
|
||
| @VisibleForTesting | ||
| Attributes toOtelAttributes(Map<String, String> attributes) { | ||
| Preconditions.checkNotNull(attributes, "Attributes map cannot be null"); | ||
| AttributesBuilder attributesBuilder = Attributes.builder(); | ||
| attributes.forEach(attributesBuilder::put); | ||
| return attributesBuilder.build(); | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.