This integration enables monitoring of your AWS API Gateway by collecting comprehensive metrics. With SigNoz's one-click AWS integration, you can track API request counts, latency, and error rates to ensure your APIs perform optimally.
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. Monitoring API Gateway is critical for understanding API usage patterns, detecting errors, and optimizing performance.
Getting Started
To use the API Gateway integration:
- From the sidebar, navigate to Integrations.
- Click Configure on the Amazon Web Services tile.
- Navigate to API Gateway to view dashboards and configure the integration.
For detailed setup instructions, see One-Click AWS Integrations.
What You'll Monitor & Data Collected
This integration collects comprehensive API Gateway metrics, providing visibility into:
Core API Gateway Metrics
- Request Count: Monitor the volume of API calls.
- Latency: Track end-to-end latency and integration latency.
- Errors: Monitor 4XX and 5XX error rates.
- Cache Performance: Track cache hit and miss counts.
Collected Data Details
📊 Metrics List
| Metric Name | Unit | Type |
|---|---|---|
| aws_ApiGateway_4XXError_count | Count | Gauge |
| aws_ApiGateway_4XXError_max | Count | Gauge |
| aws_ApiGateway_4XXError_min | Count | Gauge |
| aws_ApiGateway_4XXError_sum | Count | Gauge |
| aws_ApiGateway_5XXError_count | Count | Gauge |
| aws_ApiGateway_5XXError_max | Count | Gauge |
| aws_ApiGateway_5XXError_min | Count | Gauge |
| aws_ApiGateway_5XXError_sum | Count | Gauge |
| aws_ApiGateway_CacheHitCount_count | Count | Gauge |
| aws_ApiGateway_CacheHitCount_max | Count | Gauge |
| aws_ApiGateway_CacheHitCount_min | Count | Gauge |
| aws_ApiGateway_CacheHitCount_sum | Count | Gauge |
| aws_ApiGateway_CacheMissCount_count | Count | Gauge |
| aws_ApiGateway_CacheMissCount_max | Count | Gauge |
| aws_ApiGateway_CacheMissCount_min | Count | Gauge |
| aws_ApiGateway_CacheMissCount_sum | Count | Gauge |
| aws_ApiGateway_Count_count | Count | Gauge |
| aws_ApiGateway_Count_max | Count | Gauge |
| aws_ApiGateway_Count_min | Count | Gauge |
| aws_ApiGateway_Count_sum | Count | Gauge |
| aws_ApiGateway_IntegrationLatency_count | Milliseconds | Gauge |
| aws_ApiGateway_IntegrationLatency_max | Milliseconds | Gauge |
| aws_ApiGateway_IntegrationLatency_min | Milliseconds | Gauge |
| aws_ApiGateway_IntegrationLatency_sum | Milliseconds | Gauge |
| aws_ApiGateway_Latency_count | Milliseconds | Gauge |
| aws_ApiGateway_Latency_max | Milliseconds | Gauge |
| aws_ApiGateway_Latency_min | Milliseconds | Gauge |
| aws_ApiGateway_Latency_sum | Milliseconds | Gauge |
📋 Logs Attributes
| Name | Path | Type |
|---|---|---|
| Account ID | resources.cloud.account.id | string |
| Log Group Name | resources.aws.cloudwatch.log_group_name | string |
| Log Stream Name | resources.aws.cloudwatch.log_stream_name | string |
Dashboards
API Gateway Overview Dashboard
The integration provides a comprehensive overview dashboard with key API Gateway metrics:
Key visualizations include:
- Request Count: Monitor the rate of API calls.
- Latency: Track end-to-end and integration latency trends.
- Error Rates: Monitor 4XX and 5XX error percentages.
- Cache Performance: Analyze cache hit/miss ratios.
