feat: add opencensus tracing/stats support #130
+139
−16
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
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,74 @@ | ||
| /* | ||
| * Copyright 2020 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.datastore; | ||
|
|
||
| import com.google.cloud.datastore.spi.v1.HttpDatastoreRpc; | ||
| import io.opencensus.trace.EndSpanOptions; | ||
| import io.opencensus.trace.Span; | ||
| import io.opencensus.trace.Tracer; | ||
| import io.opencensus.trace.Tracing; | ||
|
|
||
| /** | ||
| * Helper class for tracing utility. It is used for instrumenting {@link HttpDatastoreRpc} with | ||
| * OpenCensus APIs. | ||
| * | ||
| * <p>TraceUtil instances are created by the {@link TraceUtil#getInstance()} method. | ||
| */ | ||
| public class TraceUtil { | ||
| private final Tracer tracer = Tracing.getTracer(); | ||
| private static final TraceUtil traceUtil = new TraceUtil(); | ||
| static final String SPAN_NAME_ALLOCATEIDS = "CloudDatastoreOperation.allocateIds"; | ||
| static final String SPAN_NAME_TRANSACTION = "CloudDatastoreOperation.readWriteTransaction"; | ||
| static final String SPAN_NAME_BEGINTRANSACTION = "CloudDatastoreOperation.beginTransaction"; | ||
| static final String SPAN_NAME_COMMIT = "CloudDatastoreOperation.commit"; | ||
| static final String SPAN_NAME_LOOKUP = "CloudDatastoreOperation.lookup"; | ||
| static final String SPAN_NAME_RESERVEIDS = "CloudDatastoreOperation.reserveIds"; | ||
| static final String SPAN_NAME_ROLLBACK = "CloudDatastoreOperation.rollback"; | ||
| static final String SPAN_NAME_RUNQUERY = "CloudDatastoreOperation.runQuery"; | ||
| static final EndSpanOptions END_SPAN_OPTIONS = | ||
BenWhitehead marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| EndSpanOptions.builder().setSampleToLocalSpanStore(true).build(); | ||
|
|
||
| /** | ||
| * Starts a new span. | ||
| * | ||
| * @param spanName The name of the returned Span. | ||
| * @return The newly created {@link Span}. | ||
| */ | ||
| protected Span startSpan(String spanName) { | ||
| return tracer.spanBuilder(spanName).startSpan(); | ||
| } | ||
|
|
||
| /** | ||
| * Return the global {@link Tracer}. | ||
| * | ||
| * @return The global {@link Tracer}. | ||
| */ | ||
| public Tracer getTracer() { | ||
| return tracer; | ||
| } | ||
|
|
||
| /** | ||
| * Return TraceUtil Object. | ||
| * | ||
| * @return An instance of {@link TraceUtil} | ||
| */ | ||
| public static TraceUtil getInstance() { | ||
|
There was a problem hiding this comment. no need, just create a TraceUtil on the field |
||
| return traceUtil; | ||
| } | ||
|
|
||
| private TraceUtil() {} | ||
| } | ||
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
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.
Any specific reason for
Status.UNKNOWNinstead ofstatus.INTERNAL? Generally, an example of (UNKNOWN) where this error may be returned is if a Status value received from another address space belongs to an error-space that is not known in this address space. On the other side, Internal errors mean some invariants expected by underlying system has been broken.Also,
DEADLINE_EXCEEDEDcan be useful in case of retries exceeded.Having said that, I am not familiar with datastore codebase. Feel free to ignore if you disagree.