Class MetricsTracer (2.55.0)

Version latest

• 2.55.0 (latest)
• 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

Beta

This library is covered by the Pre-GA Offerings Terms of the Terms of Service. Pre-GA libraries might have limited support, and changes to pre-GA libraries might not be compatible with other pre-GA versions. For more information, see the launch stage descriptions.

public class MetricsTracer implements ApiTracer

This class computes generic metrics that can be observed in the lifecycle of an RPC operation. The responsibility of recording metrics should delegate to MetricsRecorder, hence this class should not have any knowledge about the observability framework used for metrics recording. method_name and language will be autopopulated attributes. Default value of language is 'Java'.

Inheritance

Object > MetricsTracer

Implements

ApiTracer

Inherited Members

Object.clone()

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.toString()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Fields

DEFAULT_LANGUAGE

public static final String DEFAULT_LANGUAGE

Field Value
Type	Description
String

LANGUAGE_ATTRIBUTE

public static final String LANGUAGE_ATTRIBUTE

Field Value
Type	Description
String

METHOD_ATTRIBUTE

public static final String METHOD_ATTRIBUTE

Field Value
Type	Description
String

STATUS_ATTRIBUTE

public static final String STATUS_ATTRIBUTE

Field Value
Type	Description
String

Constructors

MetricsTracer(MethodName methodName, MetricsRecorder metricsRecorder)

public MetricsTracer(MethodName methodName, MetricsRecorder metricsRecorder)

Parameters
Name	Description
methodName	MethodName
metricsRecorder	MetricsRecorder

Methods

addAttributes(String key, String value)

public void addAttributes(String key, String value)

Add attributes that will be attached to all metrics. This is expected to be called by handwritten client teams to add additional attributes that are not supposed be collected by Gax.

Parameters
Name	Description
key	String
value	String

addAttributes(Map<String,String> attributes)

public void addAttributes(Map<String,String> attributes)

Add attributes that will be attached to all metrics. This is expected to be called by handwritten client teams to add additional attributes that are not supposed be collected by Gax.

Parameter
Name	Description
attributes	Map<String,String>

attemptCancelled()

public void attemptCancelled()

Add an annotation that the attempt was cancelled by the user. Cancelled attempt add "CANCELLED" to the status attribute key.

attemptFailed(Throwable error, Duration delay)

public void attemptFailed(Throwable error, Duration delay)

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)

public void attemptFailedDuration(Throwable error, Duration delay)

Adds an annotation that the attempt failed, but another attempt will be made after the delay.

Parameters
Name	Description
error	Throwable the error that caused the attempt to fail.
delay	Duration the amount of time to wait before the next attempt will start. Failed attempt extracts the error from the throwable and adds it to the status attribute key.

attemptFailedRetriesExhausted(Throwable error)

public void attemptFailedRetriesExhausted(Throwable error)

Adds an annotation that the attempt failed and that no further attempts will be made because retry limits have been reached. This extracts the error from the throwable and adds it to the status attribute key.

Parameter
Name	Description
error	Throwable the last error received before retries were exhausted.

attemptPermanentFailure(Throwable error)

public void attemptPermanentFailure(Throwable error)

Adds an annotation that the attempt failed and that no further attempts will be made because the last error was not retryable. This extracts the error from the throwable and adds it to the status attribute key.

Parameter
Name	Description
error	Throwable the error that caused the final attempt to fail.

attemptStarted(Object request, int attemptNumber)

public void attemptStarted(Object request, int attemptNumber)

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. When the attempt starts, the attemptTimer starts the stopwatch.

Parameters
Name	Description
request	Object request of this attempt.
attemptNumber	int the zero based sequential attempt number.

attemptSucceeded()

public void attemptSucceeded()

Adds an annotation that the attempt succeeded. Successful attempt add "OK" value to the status attribute key.

operationCancelled()

public void operationCancelled()

Signals that the operation was cancelled by the user. The tracer is now considered closed and should no longer be used. Cancelled operation adds "CANCELLED" value to the status attribute key.

operationFailed(Throwable error)

public void operationFailed(Throwable error)

Signals that the operation was cancelled by the user. The tracer is now considered closed and should no longer be used. Failed operation extracts the error from the throwable and adds it to the status attribute key.

Parameter
Name	Description
error	Throwable

operationSucceeded()

public void operationSucceeded()

Signals that the overall operation has finished successfully. The tracer is now considered closed and should no longer be used. Successful operation adds "OK" value to the status attribute key.