Amazon API Gateway

Dynatrace ingests metrics for multiple preselected namespaces, including Amazon API Gateway. You can view metrics for each service instance, split metrics into multiple dimensions, and create custom charts that you can pin to your dashboards.

Prerequisites

To enable monitoring for this service, you need

  • An Environment or Cluster ActiveGate version 1.181+
  • Dynatrace version 1.182+
  • An updated AWS monitoring policy to include the additional AWS services.
    To update the AWS IAM policy, use the JSON below, containing the monitoring policy (permissions) for all supporting services.

If you don't want to add permissions to all services, and just select permissions for certain services, consult the table below. The table contains a set of permissions that are required for all services (All monitored Amazon services) and, for each supporting service, a list of optional permissions specific to that service.

Example of JSON policy for one single service.

In this example, from the complete list of permissions you need to select

  • "apigateway:GET" for Amazon API Gateway
  • "cloudwatch:GetMetricData", "cloudwatch:GetMetricStatistics", "cloudwatch:ListMetrics", "sts:GetCallerIdentity", "tag:GetResources", "tag:GetTagKeys", and "ec2:DescribeAvailabilityZones" for All monitored Amazon services.

Add the service to monitoring

In order to view the service metrics, you must add the service to monitoring in your Dynatrace environment.

Note: Once AWS supporting services are added to monitoring, you might have to wait 15-20 minutes before the metric values are displayed.

Configure service metrics

Once you add a service, Dynatrace starts automatically collecting a suite of metrics for this particular service. These are recommended metrics. Apart from the recommended metrics, most services have the possibility of enabling optional metrics. You can remove or edit any of the existing metrics or any of their dimensions, where there are multiple dimensions available. Metrics consisting of only one dimension can't be edited. They can only be removed or added.

Service-wide metrics are metrics for the whole service across all regions. Typically, these metrics include dimensions containing Region in their name. If selected, these metrics are displayed on a separate chart when viewing your AWS deployment in Dynatrace. Keep in mind that available dimensions differ among services.

To change a metric's statistics, you have to recreate that metric by choosing different statistics. You can choose among the following statistics: Sum, Minimum, Maximum, Average, and Sample count. The Average + Minimum + Maximum statistics enable you to collect all three statistics as one metric instead of one statistic for three metrics separately. This can reduce your expenses for retrieving metrics from your AWS deployment.

To be able to save a newly added metric, you need to select at least one statistic and one dimension.

Note: Once AWS supporting services are configured, you might have to wait 15-20 minutes before the metric values are displayed.

View service metrics

Once you add the service to monitoring, you can view the service metrics in your Dynatrace environment either on your dashboard page or on the custom device overview page.

Available metrics

Name Description Unit Statistics Dimensions Recommended
4XXError The number of client-side errors captured in a given period Count Sum ApiName ✔️
4XXError Count Sum ApiName, Stage; ApiName, Stage, Resource, Method
5XXError The number of server-side errors captured in a given period Count Sum ApiName ✔️
5XXError Count Sum ApiName, Stage; ApiName, Stage, Resource, Method
CacheHitCount The number of requests served from the API cache in a given period Count Sum ApiName; ApiName, Stage; ApiName, Stage, Resource, Method
CacheMissCount The number of requests served from the backend in a given period, when API caching is enabled Count Sum ApiName; ApiName, Stage; ApiName, Stage, Resource, Method
Count The total number API requests in a given period Count Sum ApiName ✔️
Count Count Sum ApiName, Stage; ApiName, Stage, Resource, Method
Count Count Sum Region
IntegrationLatency The time between when API Gateway relays a request to the backend and when it receives a response from the backend Milliseconds Multi ApiName ✔️
IntegrationLatency Milliseconds Multi ApiName, Stage; ApiName, Stage, Resource, Method
Latency 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. Milliseconds Multi ApiName ✔️
Latency Milliseconds Multi ApiName, Stage; ApiName, Stage, Resource, Method