-
Notifications
You must be signed in to change notification settings - Fork 72
chore: PoC for App Centric metrics #4110
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
Draft
blakeli0
wants to merge
2
commits into
main
Choose a base branch
from
poc-metrics
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
Show all changes
2 commits
Select commit
Hold shift + click to select a range
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
90 changes: 90 additions & 0 deletions
90
gax-java/gax/src/main/java/com/google/api/gax/tracing/AppCentricMetricsRecorder.java
This file contains hidden or 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,90 @@ | ||
| /* | ||
| * Copyright 2024 Google LLC | ||
| * | ||
| * Redistribution and use in source and binary forms, with or without | ||
| * modification, are permitted provided that the following conditions are | ||
| * met: | ||
| * | ||
| * * Redistributions of source code must retain the above copyright | ||
| * notice, this list of conditions and the following disclaimer. | ||
| * * Redistributions in binary form must reproduce the above | ||
| * copyright notice, this list of conditions and the following disclaimer | ||
| * in the documentation and/or other materials provided with the | ||
| * distribution. | ||
| * * Neither the name of Google LLC nor the names of its | ||
| * contributors may be used to endorse or promote products derived from | ||
| * this software without specific prior written permission. | ||
| * | ||
| * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS | ||
| * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT | ||
| * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR | ||
| * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT | ||
| * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, | ||
| * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT | ||
| * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, | ||
| * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY | ||
| * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT | ||
| * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE | ||
| * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. | ||
| */ | ||
|
|
||
| package com.google.api.gax.tracing; | ||
|
|
||
| import com.google.api.core.BetaApi; | ||
| import com.google.api.core.InternalApi; | ||
| 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.Map; | ||
|
|
||
| @BetaApi | ||
| @InternalApi | ||
| public class AppCentricMetricsRecorder implements MetricsRecorder { | ||
|
|
||
| public static final String GAX_METER_NAME = "gax-java"; | ||
| private final DoubleHistogram requestDurationRecorder; | ||
| private final String serviceName; | ||
|
|
||
| public AppCentricMetricsRecorder(OpenTelemetry openTelemetry, String serviceName) { | ||
|
|
||
| Meter meter = | ||
| openTelemetry | ||
| .meterBuilder(GAX_METER_NAME) | ||
| .setInstrumentationVersion(GaxProperties.getGaxVersion()) | ||
| .build(); | ||
| this.serviceName = serviceName; | ||
| this.requestDurationRecorder = | ||
| meter | ||
| .histogramBuilder("gcp.client.request.duration") | ||
| .setDescription( | ||
| "Measures the total time taken for a logical client request (T3 span), including any retries, backoff, and pre/post-processing.") | ||
| .setUnit("s") | ||
| .build(); | ||
| } | ||
|
|
||
| /** | ||
| * Record the latency for the entire operation. This is the latency for the entire RPC, including | ||
| * all the retry attempts | ||
| * | ||
| * @param operationLatency Operation Latency in ms | ||
| * @param attributes Map of the attributes to store | ||
| */ | ||
| @Override | ||
| public void recordOperationLatency(double operationLatency, Map<String, String> attributes) { | ||
| requestDurationRecorder.record(operationLatency, toOtelAttributes(attributes)); | ||
| } | ||
|
|
||
| @VisibleForTesting | ||
| Attributes toOtelAttributes(Map<String, String> attributes) { | ||
| Preconditions.checkNotNull(attributes, "Attributes map cannot be null"); | ||
| AttributesBuilder attributesBuilder = Attributes.builder(); | ||
| attributes.forEach(attributesBuilder::put); | ||
| attributesBuilder.put("gcp.client.service", serviceName); | ||
| return attributesBuilder.build(); | ||
| } | ||
| } | ||
This file contains hidden or 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.
There is a unit mismatch here. The Javadoc for
operationLatencyon line 74 specifies the unit as milliseconds (ms), but therequestDurationRecorderhistogram is configured with seconds (s) as its unit on line 66. The value is being recorded without conversion.This will lead to incorrect metric values (e.g., a latency of 100ms will be recorded as 100s).
Please convert the latency to seconds before recording.