Interface MetricsRecorder (2.57.0)

Version 2.57.0

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

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 interface MetricsRecorder

Provides an interface for metrics recording. The implementer is expected to use an observability framework, e.g. OpenTelemetry. There should be only one instance of MetricsRecorder per client, all the methods in this class are expected to be called from multiple threads, hence the implementation must be thread safe.

Methods

recordAttemptCount(long count, Map<String,String> attributes)

public default void recordAttemptCount(long count, Map<String,String> attributes)

Records the count of RPC attempts

Parameters
Name	Description
count	long
attributes	Map<String,String>

recordAttemptLatency(double attemptLatency, Map<String,String> attributes)

public default void recordAttemptLatency(double attemptLatency, Map<String,String> attributes)

Records the latency of an RPC attempt

Parameters
Name	Description
attemptLatency	double
attributes	Map<String,String>

recordOperationCount(long count, Map<String,String> attributes)

public default void recordOperationCount(long count, Map<String,String> attributes)

Records the count of operations

Parameters
Name	Description
count	long
attributes	Map<String,String>

recordOperationLatency(double operationLatency, Map<String,String> attributes)

public default void recordOperationLatency(double operationLatency, Map<String,String> attributes)

Records the total end-to-end latency for an operation, including the initial RPC attempts and subsequent retries.

Parameters
Name	Description
operationLatency	double
attributes	Map<String,String>