Información general

Amazon API Gateway es un servicio totalmente gestionado que facilita a los desarrolladores la creación, la publicación, el mantenimiento, la monitorización y la protección de API a cualquier escala.

Habilita esta integración para ver todas tus métricas de API Gateway en Datadog.

Configuración

Instalación

Si aún no lo has hecho, configura primero la integración Amazon Web Services.

Recopilación de métricas

1. En la página de la integración de AWS, asegúrate de que API Gateway está habilitado en la pestaña Metric Collection.

2. Añade los siguientes permisos a tu política IAM Datadog para que se apliquen etiquetas personalizadas a las etapas de API Gateway:

   • apigateway:GET
   • tag:GetResources

3. Instala la integración Datadog - Amazon API Gateway.

A cada una de las métricas recuperadas de AWS se le asignan las mismas etiquetas que aparecen en la consola de AWS, incluyendo nombre de host, grupos de seguridad, etc.

Nota: Si has activado métricas de CloudWatch detalladas, debes activarlas para todos los recursos y las rutas que componen una etapa. De lo contrario, los valores agregados en Datadog no serán correctos.

Recopilación de logs

Para activar el registro de API Gateway:

1. Abre API Gateway en tu consola AWS.

2. Selecciona la API deseada.

3. En el menú desplegable Monitor de la pestaña de navegación de la izquierda, selecciona Logging (Generación de logs). Si no ves la pestaña de navegación de la izquierda, haz clic en el icono de tres puntos situado junto al hilo de Ariadna API Gateway en la parte superior izquierda.

4. Selecciona una etapa.

5. En la sección Access logging (Generación de logs de acceso), haz clic en Edit (Editar).

6. Activa la opción Access logging (Generación de logs de acceso).

7. Para el log de destino, asegúrate de que el nombre de tu grupo CloudWatch Log empieza por api-gateway.

8. Selecciona el formato JSON (también se admiten CLF y CSV) y añade lo siguiente en el cuadro Log format (Formato de log):

   {
       "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
   }
   

9. Haz clic en Save (Guardar).

Enviar logs a Datadog

1. Si aún no lo has hecho, configura la función AWS Lambda de recopilación de logs de Datadog.
2. Una vez instalada la función de Lambda, añade manualmente un activador en el grupo de log de CloudWatch que contiene tus logs de API Gateway en la consola de AWS. Selecciona el grupo de logs CloudWatch correspondiente, ponle un nombre al filtro (y deja el filtro vacío si quieres) y añade el desencadenador.

Una vez hecho, ve a la página de logs para empezar a explorar tus logs.

Datos recopilados

Métricas

Eventos

La integración de Amazon API Gateway no incluye ningún evento.

Checks de servicio

La integración de Amazon API Gateway no incluye ningún check de servicio.

Solucionar problemas

¿Necesitas ayuda? Ponte en contacto con el soporte de Datadog.