Documentation forSolarWinds Observability SaaS

API Gateway metrics

Amazon API Gateway is a fully managed service that makes it easy for developers to create, publish, maintain, monitor, and secure APIs at any scale. Ensure your cloud platform is configured in SolarWinds Observability SaaS to collect this service's data. See Add an AWS cloud account. CloudWatch metrics must also be enabled for this service in the AWS Console for the metric data to be available.

Depending on the subscription pricing tier of your AWS account or its services, additional metrics may be available for this entity. To collect additional AWS metrics, set the dimensions for API Gateway metrics.

Many of the collected metrics from API Gateway entities are displayed as widgets in SolarWinds Observability explorers; additional metrics may be collected and available in the Metrics Explorer. You can also create an alert for when an entity's metric value moves out of a specific range. See Entities in SolarWinds Observability SaaS for information about entity types in SolarWinds Observability SaaS.

The following table lists some of the metrics collected for these entities. To see the API Gateway metrics in the Metrics Explorer, type AWS.ApiGateway in the search box.

Metric Units Description
sw.metrics.healthscore Percent (%)

Health score. A health score provides real-time insight into the overall health and performance of your monitored entities. The health score is calculated based on anomalies detected for the entity, alerts triggered for the entity's metrics, and the status of the entity. The health score is displayed as a single numerical value that ranges from a Good (70-100) to Moderate (40-69) to Bad (0-39) distinction.

To view the health score for API Gateway entities in the Metrics Explorer, filter the sw.metrics.healthscore metric by entity_types and select awsapigateway.
AWS.ApiGateway.4XXError Count

4XXError. The total number of client-side errors for REST APIs captured in a given period.
AWS.ApiGateway.4xx Count

4xx. The total number of client-side errors for HTTP APIs captured in a given period.

AWS.ApiGateway.5XXError Count

5XXError. The total number of server-side errors for REST APIs captured in a given period.

AWS.ApiGateway.5xx Count

5xx. The total number of server-side errors for HTTP APIs captured in a given period.

AWS.ApiGateway.CacheHitCount Count

CacheHitCount. The total number of requests served from the API cache in a given period.

AWS.ApiGateway.CacheMissCount Count

CacheMissCount. The total number of requests served from the backend in a given period, when API caching is enabled.

AWS.ApiGateway.ClientError Count

ClientError. The total number of requests that have a 4XX response returned by API Gateway before the integration is invoked.

AWS.ApiGateway.ConnectCount Count

ConnectCount. The total number of messages sent to the connect route integration.

AWS.ApiGateway.Count Count

Count. The total number of API requests in a given period.

AWS.ApiGateway.DataProcessed bytes

DataProcessed. The total amount of data processed in bytes.

AWS.ApiGateway.ExecutionError Count

ExecutionError. The total number of errors that occurred when calling the integration.

AWS.ApiGateway.IntegrationError Count

IntegrationError. The total number of requests that return a 4XX or 5XX response from the integration.

AWS.ApiGateway.IntegrationLatency milliseconds (ms)

IntegrationLatency. The average time between when API Gateway relays a request to the backend and when it receives a response from the backend.

AWS.ApiGateway.Latency milliseconds (ms)

Latency. The average time between when API Gateway receives a request from a client and when it returns a response to the client.

AWS.ApiGateway.MessageCount Count

MessageCount. The total number of messages sent to the WebSocket API, either from or to the client.