Interface ApiTracer (2.59.1)
- 2.72.2 (latest)
- 2.72.1
- 2.71.0
- 2.70.3
- 2.69.0
- 2.68.2
- 2.67.0
- 2.66.0
- 2.65.0
- 2.63.1
- 2.62.0
- 2.61.0
- 2.60.0
- 2.59.1
- 2.58.0
- 2.57.0
- 2.55.0
- 2.54.1
- 2.53.0
- 2.52.0
- 2.51.0
- 2.50.0
- 2.49.0
- 2.48.1
- 2.47.0
- 2.46.1
- 2.45.0
- 2.43.0
- 2.42.0
- 2.41.0
- 2.39.0
- 2.38.0
- 2.37.0
- 2.36.0
- 2.35.0
- 2.34.1
- 2.33.0
- 2.32.1
- 2.31.1
- 2.30.1
- 2.24.0
- 2.23.3
- 2.22.0
- 2.21.0
- 2.20.1
- 2.19.6
- 2.18.7
- 2.17.0
- 2.16.0
- 2.15.0
- 2.14.0
- 2.13.0
- 2.12.2
- 2.11.0
- 2.10.0
- 2.9.0
- 2.8.1
- 2.7.1
publicinterfaceApiTracerImplementations of this class trace the logical flow of a google cloud client.
A single instance of a tracer represents a logical operation that can be annotated throughout its lifecycle. Constructing an instance of a subclass will implicitly signal the start of a new operation.
For internal use only. google-cloud-java libraries should extendBaseApiTracer.
Methods
attemptCancelled()
publicdefaultvoidattemptCancelled()Add an annotation that the attempt was cancelled by the user.
attemptFailed(Throwable error, Duration delay)
publicdefaultvoidattemptFailed(Throwableerror,Durationdelay)Obsolete
Use attemptFailedDuration(Throwable, java.time.Duration) instead
This feature is stable for usage in this major version, but may be deprecated in a future release.
This method is obsolete. Use#attemptFailedDuration(Throwable, java.time.Duration) instead.
| Parameters | |
|---|---|
| Name | Description |
error | Throwable |
delay | org.threeten.bp.Duration |
attemptFailedDuration(Throwable error, Duration delay)
publicdefaultvoidattemptFailedDuration(Throwableerror,Durationdelay)Adds an annotation that the attempt failed, but another attempt will be made after the delay.
| Parameters | |
|---|---|
| Name | Description |
error | Throwablethe transient error that caused the attempt to fail. |
delay | Durationthe amount of time to wait before the next attempt will start. |
attemptFailedRetriesExhausted(Throwable error)
publicdefaultvoidattemptFailedRetriesExhausted(Throwableerror)Adds an annotation that the attempt failed and that no further attempts will be made because retry limits have been reached.
| Parameter | |
|---|---|
| Name | Description |
error | Throwablethe last error received before retries were exhausted. |
attemptPermanentFailure(Throwable error)
publicdefaultvoidattemptPermanentFailure(Throwableerror)Adds an annotation that the attempt failed and that no further attempts will be made because the last error was not retryable.
| Parameter | |
|---|---|
| Name | Description |
error | Throwablethe error that caused the final attempt to fail. |
attemptStarted(int attemptNumber) (deprecated)
publicdefaultvoidattemptStarted(intattemptNumber)Deprecated.Please use#attemptStarted(Object, int) instead.
Adds an annotation that an attempt is about to start. In general this should occur at the very start of the operation. The attemptNumber is zero based. So the initial attempt will be 0.
| Parameter | |
|---|---|
| Name | Description |
attemptNumber | intthe zero based sequential attempt number. |
attemptStarted(Object request, int attemptNumber)
publicdefaultvoidattemptStarted(Objectrequest,intattemptNumber)Adds an annotation that an attempt is about to start with additional information from the request. In general this should occur at the very start of the operation. The attemptNumber is zero based. So the initial attempt will be 0.
| Parameters | |
|---|---|
| Name | Description |
request | Objectrequest of this attempt. |
attemptNumber | intthe zero based sequential attempt number. |
attemptSucceeded()
publicdefaultvoidattemptSucceeded()Adds an annotation that the attempt succeeded.
batchRequestSent(long elementCount, long requestSize)
publicdefaultvoidbatchRequestSent(longelementCount,longrequestSize)Adds an annotation that a batch of writes has been flushed.
| Parameters | |
|---|---|
| Name | Description |
elementCount | longthe number of elements in the batch. |
requestSize | longthe size of the batch in bytes. |
connectionSelected(String id)
publicdefaultvoidconnectionSelected(Stringid)Annotates the operation with selected connection id from theChannelPool.
| Parameter | |
|---|---|
| Name | Description |
id | Stringthe local connection identifier of the selected connection. |
inScope()
publicdefaultApiTracer.ScopeinScope()Asks the underlying implementation to install itself as a thread local. This allows for interop between clients using gax and external resources to share the same implementation of the tracing. For example OpenCensus will install a thread local that can read by the GRPC.
| Returns | |
|---|---|
| Type | Description |
ApiTracer.Scope | |
lroStartFailed(Throwable error)
publicdefaultvoidlroStartFailed(Throwableerror)Signals that the initial RPC for the long running operation failed.
| Parameter | |
|---|---|
| Name | Description |
error | Throwablethe error that caused the long running operation fail. |
lroStartSucceeded()
publicdefaultvoidlroStartSucceeded()Signals that the initial RPC successfully started the long running operation. The long running operation will now be polled for completion.
operationCancelled()
publicdefaultvoidoperationCancelled()Signals that the operation was cancelled by the user. The tracer is now considered closed and should no longer be used.
operationFailed(Throwable error)
publicdefaultvoidoperationFailed(Throwableerror)Signals that the overall operation has failed and no further attempts will be made. The tracer is now considered closed and should no longer be used.
| Parameter | |
|---|---|
| Name | Description |
error | Throwablethe final error that caused the operation to fail. |
operationSucceeded()
publicdefaultvoidoperationSucceeded()Signals that the overall operation has finished successfully. The tracer is now considered closed and should no longer be used.
requestSent()
publicdefaultvoidrequestSent()Adds an annotation that a streaming request has been sent.
responseReceived()
publicdefaultvoidresponseReceived()Adds an annotation that a streaming response has been received.
Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-12-17 UTC.