software.amazon.awssdk.core.metrics

Class CoreMetric

java.lang.Object

software.amazon.awssdk.core.metrics.CoreMetric

public final class CoreMetric
extends Object

Field Summary

Fields

Modifier and Type	Field and Description
static SdkMetric<Duration>	API_CALL_DURATION The duration of the API call.
static SdkMetric<Boolean>	API_CALL_SUCCESSFUL True if the API call succeeded, false otherwise.
static SdkMetric<String>	AWS_EXTENDED_REQUEST_ID The extended request ID of the service request.
static SdkMetric<String>	AWS_REQUEST_ID The request ID of the service request.
static SdkMetric<Duration>	BACKOFF_DELAY_DURATION The duration of time that the SDK has waited before this API call attempt, based on the RetryPolicy.backoffStrategy().
static SdkMetric<Duration>	CREDENTIALS_FETCH_DURATION The duration of time taken to fetch signing credentials for the API call.
static SdkMetric<Duration>	MARSHALLING_DURATION The duration of time taken to marshall the SDK request to an HTTP request.
static SdkMetric<String>	OPERATION_NAME The name of the service operation being invoked.
static SdkMetric<Integer>	RETRY_COUNT The number of retries that the SDK performed in the execution of the request.
static SdkMetric<Duration>	SERVICE_CALL_DURATION The duration of time taken to connect to the service (or acquire a connection from the connection pool), send the serialized request and receive the initial response (e.g.
static SdkMetric<String>	SERVICE_ID The unique ID for the service.
static SdkMetric<Duration>	SIGNING_DURATION The duration of time taken to sign the HTTP request.
static SdkMetric<Duration>	TOKEN_FETCH_DURATION The duration of time taken to fetch signing credentials for the API call.
static SdkMetric<Duration>	UNMARSHALLING_DURATION The duration of time taken to unmarshall the HTTP response to an SDK response.

Method Summary

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

SERVICE_ID

public static final SdkMetric<String> SERVICE_ID

The unique ID for the service. This is present for all API call metrics.

OPERATION_NAME

public static final SdkMetric<String> OPERATION_NAME

The name of the service operation being invoked. This is present for all API call metrics.

API_CALL_SUCCESSFUL

public static final SdkMetric<Boolean> API_CALL_SUCCESSFUL

True if the API call succeeded, false otherwise.

RETRY_COUNT

public static final SdkMetric<Integer> RETRY_COUNT

The number of retries that the SDK performed in the execution of the request. 0 implies that the request worked the first time, and no retries were attempted.

API_CALL_DURATION

public static final SdkMetric<Duration> API_CALL_DURATION

The duration of the API call. This includes all call attempts made.

API_CALL_DURATION ~= CREDENTIALS_FETCH_DURATION + MARSHALLING_DURATION + SUM_ALL(BACKOFF_DELAY_DURATION) + SUM_ALL(SIGNING_DURATION) + SUM_ALL(SERVICE_CALL_DURATION) + SUM_ALL(UNMARSHALLING_DURATION)

CREDENTIALS_FETCH_DURATION

public static final SdkMetric<Duration> CREDENTIALS_FETCH_DURATION

The duration of time taken to fetch signing credentials for the API call.

TOKEN_FETCH_DURATION

public static final SdkMetric<Duration> TOKEN_FETCH_DURATION

The duration of time taken to fetch signing credentials for the API call.

BACKOFF_DELAY_DURATION

public static final SdkMetric<Duration> BACKOFF_DELAY_DURATION

The duration of time that the SDK has waited before this API call attempt, based on the RetryPolicy.backoffStrategy().

MARSHALLING_DURATION

public static final SdkMetric<Duration> MARSHALLING_DURATION

The duration of time taken to marshall the SDK request to an HTTP request.

SIGNING_DURATION

public static final SdkMetric<Duration> SIGNING_DURATION

The duration of time taken to sign the HTTP request.

SERVICE_CALL_DURATION

public static final SdkMetric<Duration> SERVICE_CALL_DURATION

The duration of time taken to connect to the service (or acquire a connection from the connection pool), send the serialized request and receive the initial response (e.g. HTTP status code and headers). This DOES NOT include the time taken to read the entire response from the service.

UNMARSHALLING_DURATION

public static final SdkMetric<Duration> UNMARSHALLING_DURATION

The duration of time taken to unmarshall the HTTP response to an SDK response.

Note: For streaming operations, this does not include the time to read the response payload.

AWS_REQUEST_ID

public static final SdkMetric<String> AWS_REQUEST_ID

The request ID of the service request.

AWS_EXTENDED_REQUEST_ID

public static final SdkMetric<String> AWS_EXTENDED_REQUEST_ID

The extended request ID of the service request.