Interface MetricsRecorder (2.37.0) 

public interface MetricsRecorder

Interface to record specific metric operations.

Warning: This is intended to be an internal API and is not intended for external use. This is public solely for implementation purposes and does not promise any backwards compatibility.

Static Methods

getInstance(DatastoreOpenTelemetryOptions options)

public static MetricsRecorder getInstance(DatastoreOpenTelemetryOptions options)

Returns a MetricsRecorder instance based on the provided OpenTelemetry options.

Parameter
Name Description
options DatastoreOpenTelemetryOptions

The com.google.cloud.datastore.DatastoreOpenTelemetryOptions configuring telemetry.
Returns
Type Description
MetricsRecorder

An OpenTelemetryMetricsRecorder if metrics are enabled, otherwise a NoOpMetricsRecorder.

Methods

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

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

Records the count of a single RPC attempt.

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

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

public abstract void recordAttemptLatency(double latencyMs, Map<String,String> attributes)

Records the latency of a single RPC attempt in milliseconds.

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

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

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

Records the count of an operation.

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

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

public abstract void recordOperationLatency(double latencyMs, Map<String,String> attributes)

Records the total latency of an operation (including retries) in milliseconds.

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

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

public abstract void recordTransactionAttemptCount(long count, Map<String,String> attributes)

Records the number of attempts a transaction took.

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

recordTransactionLatency(double latencyMs, Map<String,String> attributes)

public abstract void recordTransactionLatency(double latencyMs, Map<String,String> attributes)

Records the total latency of a transaction in milliseconds.

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