-
Notifications
You must be signed in to change notification settings - Fork 123
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Adding gfe_latencies metric to built-in metrics #3490
Draft
surbhigarg92
wants to merge
1
commit into
googleapis:main
Choose a base branch
from
surbhigarg92:gfe_latency
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Draft
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Can we make this compatible with other server timing headers?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
More specifically, a server timing header is in the format of
[component]; dur=[latency], as stated in the w3c standard.gfet4t7is just one of the possible component and it is not guaranteed to be the first one, sostartsWithshall be changed to something likecontains.