- 필수 기능
- 시작하기
- Glossary
- 표준 속성
- Guides
- Agent
- 통합
- 개방형텔레메트리
- 개발자
- Administrator's Guide
- API
- Datadog Mobile App
- CoScreen
- Cloudcraft
- 앱 내
- 서비스 관리
- 인프라스트럭처
- 애플리케이션 성능
- APM
- Continuous Profiler
- 스팬 시각화
- 데이터 스트림 모니터링
- 데이터 작업 모니터링
- 디지털 경험
- 소프트웨어 제공
- 보안
- AI Observability
- 로그 관리
- 관리
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.
Enable this integration to see all of your API Gateway metrics in Datadog.
If you haven’t already, set up the Amazon Web Services integration.
On the AWS integration page, ensure that API Gateway
is enabled under the Metric Collection
tab.
Add the following permissions to your Datadog IAM policy in order to get custom tags applied to API Gateway Stages:
apigateway:GET
tag:GetResources
Install the Datadog - Amazon API Gateway integration.
Each of the metrics retrieved from AWS are assigned the same tags that appear in the AWS console, including but not limited to host name, security-groups, and more.
Note: If you’ve enabled detailed CloudWatch metrics, you must enable them for all Resources or Routes within a Stage. Otherwise, aggregate values in Datadog will be incorrect.
To enable API Gateway logging:
Go to API Gateway in your AWS console.
Select the wanted API and go to the Stages section.
In the Logs tab, enable Enable CloudWatch Logs and Enable Access Logging.
Select the INFO
level to make sure you have all the requests.
Make sure your CloudWatch Group name starts with api-gateway
.
Select the JSON format (CLF and CSV are also supported) and add the following in the Log format box:
{
"apiId": "$context.apiId",
"stage": "$context.stage",
"requestId":"$context.requestId",
"ip":"$context.identity.sourceIp",
"caller":"$context.identity.caller",
"user":"$context.identity.user",
"requestTime":$context.requestTimeEpoch,
"httpMethod":"$context.httpMethod",
"resourcePath":"$context.resourcePath",
"status":$context.status,
"protocol":"$context.protocol",
"responseLength":$context.responseLength
}
Once completed, navigate to the Logs page to start exploring your logs!
aws.apigateway.4xx (count) | The number of client-side errors for HTTP APIs Shown as operation |
aws.apigateway.4xxerror (count) | The number of client-side errors for REST APIs Shown as operation |
aws.apigateway.5xx (count) | The number of server-side errors for HTTP APIs Shown as operation |
aws.apigateway.5xxerror (count) | The number of server-side errors for REST APIs Shown as operation |
aws.apigateway.cache_hit_count (count) | The number of requests served from the API cache Shown as operation |
aws.apigateway.cache_miss_count (count) | The number of requests served from the back end when API caching is enabled Shown as operation |
aws.apigateway.client_error (count) | The average number of requests that have a 4XX response returned by API Gateway before the integration is invoked. Shown as operation |
aws.apigateway.client_error.sum (count) | The total number of requests that have a 4XX response returned by API Gateway before the integration is invoked. Shown as operation |
aws.apigateway.connect_count (count) | The average number of messages sent to the $connect route integration. Shown as operation |
aws.apigateway.connect_count.sum (count) | The total number of messages sent to the $connect route integration. Shown as operation |
aws.apigateway.count (count) | The number call to API methods Shown as operation |
aws.apigateway.execution_error (count) | Average errors that occurred when calling the integration. Shown as operation |
aws.apigateway.execution_error.sum (count) | Total errors that occurred when calling the integration. Shown as operation |
aws.apigateway.integration_error (count) | The average number of requests that return a 4XX/5XX response from the integration. Shown as operation |
aws.apigateway.integration_error.sum (count) | The total number of requests that return a 4XX/5XX response from the integration. Shown as operation |
aws.apigateway.integration_latency (gauge) | The time between when API Gateway relays a request to the back end and when it receives a response from the back end. Shown as millisecond |
aws.apigateway.integration_latency.maximum (gauge) | The maximum time between when API Gateway relays a request to the back end and when it receives a response from the back end. Shown as millisecond |
aws.apigateway.integration_latency.minimum (gauge) | The minimum time between when API Gateway relays a request to the back end and when it receives a response from the back end. Shown as millisecond |
aws.apigateway.integration_latency.p90 (gauge) | The 90th percentile time between when API Gateway relays a request to the back end and when it receives a response from the back end. Shown as millisecond |
aws.apigateway.integration_latency.p95 (gauge) | The 95th percentile time between when API Gateway relays a request to the back end and when it receives a response from the back end. Shown as millisecond |
aws.apigateway.integration_latency.p99 (gauge) | The 99th percentile time between when API Gateway relays a request to the back end and when it receives a response from the back end. Shown as millisecond |
aws.apigateway.latency (gauge) | The time between when API Gateway receives a request from a client and when it returns a response to the client. The latency includes the integration_latency and other API Gateway overhead. Shown as millisecond |
aws.apigateway.latency.maximum (gauge) | The maximum time between when requests are received and when responses returned Shown as millisecond |
aws.apigateway.latency.minimum (gauge) | The minimum time between when requests are received and when responses returned Shown as millisecond |
aws.apigateway.latency.p50 (gauge) | The 50th percentile time between when requests are received and when responses returned Shown as millisecond |
aws.apigateway.latency.p75 (gauge) | The 75th percentile time between when requests are received and when responses returned Shown as millisecond |
aws.apigateway.latency.p90 (gauge) | The 90th percentile time between when requests are received and when responses returned Shown as millisecond |
aws.apigateway.latency.p95 (gauge) | The 95th percentile time between when requests are received and when responses returned Shown as millisecond |
aws.apigateway.latency.p99 (gauge) | The 99th percentile time between when requests are received and when responses returned Shown as millisecond |
aws.apigateway.message_count (count) | The average number of messages sent to the WebSocket API, either from or to the client. Shown as operation |
aws.apigateway.message_count.sum (count) | The total number of messages sent to the WebSocket API, either from or to the client. Shown as operation |
The Amazon API Gateway integration does not include any events.
The Amazon API Gateway integration does not include any service checks.
Need help? Contact Datadog support.