Apollo

Supported OS

Información general

La integración Apollo en Datadog te permite reenviar métricas de rendimiento de Studio a tu cuenta Datadog. Datadog es compatible con una API de función avanzada, lo que te permite crear gráficos y alertas de métricas de GraphQL.

Metrics

Studio reenvía las siguientes métricas a Datadog:

  • apollo.operations.count - El número de operaciones GraphQL que se ejecutaron. Esto incluye consultas, mutaciones y operaciones que dieron lugar a un error.

  • apollo.operations.error_count - El número de operaciones GraphQL que dieron lugar a un error. Esto incluye errores de ejecución de GraphQL y errores HTTP si Studio no pudo conectarse a tu servidor.

  • apollo.operations.cache_hit_count - Número de consultas GraphQL cuyo resultado se ha obtenido de la caché de consultas completas del servidor Apollo.

  • Un histograma de los tiempos de respuesta de las operaciones GraphQL medidos en milisegundos. Debido al método de agregación de Studio (binning logarítmico), estos valores tienen una precisión de +/- 5%:

    • apollo.operations.latency.min
    • apollo.operations.latency.median
    • apollo.operations.latency.95percentile
    • apollo.operations.latency.99percentile
    • apollo.operations.latency.max
    • apollo.operations.latency.avg

Estas métricas se agregan en intervalos de 60 segundos y se etiquetan con el nombre de la operación GraphQL como operation:<query-name>. Las firmas de consulta única con el mismo nombre de operación se fusionan y las consultas sin nombre de operación se ignoran.

Estas métricas también se etiquetan con el ID del gráfico de Studio asociado (como graph:<graph-id>) y el nombre de la variante asociada (como variant:<variant-name>), por lo que varios gráficos de Studio pueden enviar datos a la misma cuenta Datadog. Si no has definido un nombre de variante, se utiliza current.

(Las integraciones configuradas antes de octubre de 2020 tienen nombres de métrica que empiezan por apollo.engine.operations en lugar de apollo.operations y utilizan una etiqueta (tag) service en lugar de graph. Puedes migrar a los nuevos nombres de métricas en la página Integraciones de tu gráfico en Apollo Studio).

Configuración

Configuración

La configuración con la integración Apollo en Datadog es tan simple como proporcionar una clave de API y una región de Datadog a Studio. No es necesaria ninguna otra configuración.

  1. Ve a tu página de integraciones Datadog y haz clic en el cuadro Apolo. A continuación, ve a la pestaña Configuración y haz clic en Install Integration (Instalar integración) en la parte inferior.

  2. Ve a tu página de las API de Datadog y crea una clave de API.

  3. Determina la región de tu API de Datadog observando la barra de direcciones de tu navegador:

  • Si el nombre de dominio es app.datadoghq.com, la región de tu API es US.
  • Si el nombre de dominio es app.datadoghq.eu, la región de tu API es EU.
  1. En Studio, ve a la página Integraciones de tu gráfico:

    IntegrationsPage

  2. En la sección de reenvío de Datadog, haz clic en Configure (Configurar). Indica tu clave y tu región de API y luego haz clic en Enable (Habilitar). Dado que todas las métricas reenviadas se etiquetan con el ID del gráfico correspondiente (graph:<graph-id>), puedes utilizar la misma clave de API para todos tus gráficos.

    IntegrationsToggle

  3. Ve al Explorador de métricas de Datadog para ver tus métricas. Las métricas pueden tardar hasta cinco minutos para ser visibles.

Uso

Consulta la documentación de las integraciones Apollo para obtener información más detallada sobre su uso.

Datos recopilados

Métricas

apollo.operations.count
(gauge)
Number of GraphQL operations (queries and mutations) processed.
Shown as operation
apollo.operations.latency.avg
(gauge)
Total request duration for a GraphQL operation, average.
Shown as millisecond
apollo.operations.latency.median
(gauge)
Total request duration for a GraphQL operation, median/50th percentile.
Shown as millisecond
apollo.operations.latency.95percentile
(gauge)
Total request duration for a GraphQL operation, 95th percentile.
Shown as millisecond
apollo.operations.latency.99percentile
(gauge)
Total request duration for a GraphQL operation, 99th percentile.
Shown as millisecond
apollo.operations.latency.max
(gauge)
Total request duration for a GraphQL operation, max/100th percentile.
Shown as millisecond
apollo.operations.latency.min
(gauge)
Total request duration for a GraphQL operation, min/0th percentile.
Shown as millisecond
apollo.operations.error_count
(gauge)
Number of GraphQL operations that resulted in a GraphQL error, including HTTP errors from origins.
Shown as error
apollo.operations.cache_hit_count
(gauge)
Number of GraphQL queries that were served from the full response cache.
Shown as hit
apollo.engine.operations.count
(gauge)
Number of GraphQL operations (queries and mutations) processed. (Legacy metric; new integrations use apollo.operations.count.)
Shown as operation
apollo.engine.operations.latency.avg
(gauge)
Total request duration for a GraphQL operation, average. (Legacy metric; new integrations use apollo.operations.latency.avg.)
Shown as millisecond
apollo.engine.operations.latency.median
(gauge)
Total request duration for a GraphQL operation, median/50th percentile. (Legacy metric; new integrations use apollo.operations.latency.median.)
Shown as millisecond
apollo.engine.operations.latency.95percentile
(gauge)
Total request duration for a GraphQL operation, 95th percentile. (Legacy metric; new integrations use apollo.operations.latency.95percentile.)
Shown as millisecond
apollo.engine.operations.latency.99percentile
(gauge)
Total request duration for a GraphQL operation, 99th percentile. (Legacy metric; new integrations use apollo.operations.latency.99percentile.)
Shown as millisecond
apollo.engine.operations.latency.max
(gauge)
Total request duration for a GraphQL operation, max/100th percentile. (Legacy metric; new integrations use apollo.operations.latency.max.)
Shown as millisecond
apollo.engine.operations.latency.min
(gauge)
Total request duration for a GraphQL operation, min/0th percentile. (Legacy metric; new integrations use apollo.operations.latency.min.)
Shown as millisecond
apollo.engine.operations.error_count
(gauge)
Number of GraphQL operations that resulted in a GraphQL error, including HTTP errors from origins. (Legacy metric; new integrations use apollo.operations.error_count.)
Shown as error
apollo.engine.operations.cache_hit_count
(gauge)
Number of GraphQL queries that were served from the full response cache. (Legacy metric; new integrations use apollo.operations.cachehitcount.)
Shown as hit

Eventos

La integración Apollo no incluye eventos en este momento.

Checks de servicio

La integración Apollo no incluye checks de servicios en este momento.

Solucionar problemas

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