Metrics
The following table lists the telemetry metrics that the SDK emits. Configure a telemetry provider to make the metrics observable.
| Metric name | Units | Type | Attributes | Description |
|---|---|---|---|---|
|
smithy.client.call.duration |
s |
Histogram |
rpc.service, rpc.method |
Overall call duration (including retries) |
|
smithy.client.call.attempts |
{attempt} |
MonotonicCounter |
rpc.service, rpc.method |
The number of attempts for an individual operation |
|
smithy.client.call.errors |
{error} |
MonotonicCounter |
rpc.service, rpc.method, exception.type |
The number of errors for an operation |
|
smithy.client.call.attempt_duration |
s |
Histogram |
rpc.service, rpc.method |
The time it takes to connect to the service, send the request, and get back HTTP status code and headers (including time queued waiting to be sent) |
|
smithy.client.call.resolve_endpoint_duration |
s |
Histogram |
rpc.service, rpc.method |
The time it takes to resolve an endpoint (endpoint resolver, not DNS) for the request |
|
smithy.client.call.serialization_duration |
s |
Histogram |
rpc.service, rpc.method |
The time it takes to serialize a message body |
|
smithy.client.call.deserialization_duration |
s |
Histogram |
rpc.service, rpc.method |
The time it takes to deserialize a message body |
|
smithy.client.call.auth.signing_duration |
s |
Histogram |
rpc.service, rpc.method, auth.scheme_id |
The time it takes to sign a request |
|
smithy.client.call.auth.resolve_identity_duration |
s |
Histogram |
rpc.service, rpc.method, auth.scheme_id |
The time it takes to acquire an identity (such as AWS credentials or a bearer token) from an Identity Provider |
|
smithy.client.http.connections.acquire_duration |
s |
Histogram |
The time it takes a request to acquire a connection |
|
|
smithy.client.http.connections.limit |
{connection} |
[Async]UpDownCounter |
The maximum open connections allowed/configured for the HTTP client |
|
|
smithy.client.http.connections.usage |
{connection} |
[Async]UpDownCounter |
state: idle | acquired |
Current state of connections pool |
|
smithy.client.http.connections.uptime |
s |
Histogram |
The amount of time a connection has been open |
|
|
smithy.client.http.requests.usage |
{request} |
[Async]UpDownCounter |
state: queued | in-flight |
The current state of HTTP client request concurrency |
|
smithy.client.http.requests.queued_duration |
s |
Histogram |
The amount of time a request spent queued and waiting to be executed by the HTTP client |
|
|
smithy.client.http.bytes_sent |
By |
MonotonicCounter |
server.address |
The total number of bytes sent by the HTTP client |
|
smithy.client.http.bytes_received |
By |
MonotonicCounter |
server.address |
The total number of bytes received by the HTTP client |
Following are the column descriptions:
-
Metric name –The name of the emitted metric.
-
Units –The unit of measure for the metric. Units are given in the UCUM
case sensitive ("c/s") notation. -
Type –The type of instrument used to capture the metric.
-
Description –A description of what the metric is measuring.
-
Attributes –The set of attributes (dimensions) emitted with the metric.
