Las traducciones son generadas a través de traducción automática. En caso de conflicto entre la traducción y la version original de inglés, prevalecerá la version en inglés.

Uso CloudWatch para monitorear y registrar datos de la API de GraphQL

Puedes registrar y depurar tu API de GraphQL CloudWatch mediante métricas CloudWatch y registros. Estas herramientas permiten a los desarrolladores supervisar el rendimiento, solucionar problemas y optimizar sus operaciones de GraphQL de forma eficaz.

CloudWatch metrics es una herramienta que proporciona una amplia gama de métricas para monitorear el rendimiento y el uso de la API. Estas métricas se dividen en las siguientes dos categorías principales:

En la guía también se presentan las métricas mejoradas, que ofrecen datos más detallados sobre el rendimiento de los solucionadores, las interacciones entre los orígenes de datos y las operaciones individuales de GraphQL. Estas métricas proporcionan información más detallada, pero conllevan costes adicionales.

CloudWatch Logs es una herramienta que habilita las capacidades de registro para su GraphQL APIs. Los registros se pueden configurar en dos niveles de la API:

Puedes configurar el registro, interpretar las entradas de registro y utilizar los datos de registro para solucionar problemas y optimizar. AWS AppSync proporciona varios tipos de registro que muestran los datos de ejecución, análisis, validación y resolución de campo de la consulta.

Ajustes y configuración

Para activar el registro automático en una API de GraphQL, usa la AWS AppSync consola.

Configuración manual del rol de IAM

Si decide utilizar una función de IAM existente, la función debe conceder AWS AppSync los permisos necesarios para escribir registros en ella. CloudWatch Para configurarlo manualmente, debe proporcionar un ARN de rol de servicio para que AWS AppSync pueda asumir el rol al escribir los registros.

En la consola de IAM, cree una nueva política con el nombre AWSAppSyncPushToCloudWatchLogsPolicy que tenga la siguiente definición:

{
    "Version": "2012-10-17",
    "Statement": [
        {
            "Effect": "Allow",
            "Action": [
                "logs:CreateLogGroup",
                "logs:CreateLogStream",
                "logs:PutLogEvents"
            ],
            "Resource": "*"
        }
    ]
}

A continuación, cree una nueva función con ese nombre AWSAppSyncPushToCloudWatchLogsRoley adjunte la política recién creada a la función. Edite la relación de confianza para este rol de la siguiente manera:

{
    "Version": "2012-10-17",
    "Statement": [
        {
        "Effect": "Allow",
        "Principal": {
            "Service": "appsync.amazonaws.com"
        },
        "Action": "sts:AssumeRole"
        }
    ]
}

Copia el ARN del rol y utilízalo al configurar el registro para una API de GraphQL AWS AppSync .

CloudWatch métricas

Puedes usar CloudWatch las métricas para monitorear y enviar alertas sobre eventos específicos que pueden resultar en códigos de estado HTTP o en la latencia. Se emiten las siguientes métricas:

Suscripciones en tiempo real

Todas las métricas se emiten en una dimensión: Graph. QLAPIId Esto significa que todas las métricas se combinan con la API GraphQL. IDs Las siguientes métricas están relacionadas con las suscripciones de GraphQL en lugar de las puras: WebSockets

Comparación de los mensajes entrantes y salientes

Cuando se ejecuta una mutación, se invocan campos de suscripción con la directiva @aws_subscribe para esa mutación. Cada invocación de suscripción genera un mensaje entrante. Por ejemplo, si dos campos de suscripción especifican la misma mutación en @aws_subscribe, se generarán dos mensajes entrantes cuando se llame a esa mutación.

Un mensaje saliente equivale a 5 KB de datos entregados a los WebSocket clientes. Por ejemplo, el envío de 15 kB de datos a 10 clientes da como resultado 30 mensajes salientes (15 kB * 10 clientes / 5 kB por mensaje = 30 mensajes).

Puede solicitar aumentos de cuota para mensajes entrantes o salientes. Para obtener más información, consulte Puntos de conexión y cuotas de AWS AppSync en la Guía de referencia general de AWS y las instrucciones sobre Cómo solicitar un aumento de cuota en la Guía del usuario de Service Quotas.

Métricas mejoradas

Las métricas mejoradas emiten datos detallados sobre el uso y el rendimiento de la API, como el recuento de solicitudes y errores de AWS AppSync , la latencia y los aciertos o errores de caché. Todos los datos métricos mejorados se envían a su CloudWatch cuenta y puede configurar los tipos de datos que se enviarán.

Estas métricas se encuentran en varias páginas de configuración de la AWS AppSync consola. En la página de configuración de la API, la sección Métricas mejoradas le permite activar o desactivar los siguientes elementos:

Comportamiento de las métricas de los solucionadores: estas opciones controlan la forma en que se recopilan las métricas adicionales de los solucionadores. Puede optar por habilitar las métricas de los solucionadores de solicitudes completas (las métricas están habilitadas para todos los solucionadores en las solicitudes), o bien las métricas por solucionador (las métricas solo están habilitadas para los solucionadores cuya configuración esté habilitada). Están disponibles las siguientes opciones:

Comportamiento de las métricas de los orígenes de datos: estas opciones controlan la forma en que se recopilan las métricas adicionales de los orígenes de datos. Puede optar por habilitar las métricas de los orígenes de datos de solicitudes completas (las métricas están habilitadas para todos los orígenes de datos en las solicitudes), o bien las métricas por origen de datos (las métricas solo están habilitadas para los orígenes de datos cuya configuración esté habilitada). Están disponibles las siguientes opciones:

Métricas de operación: habilita métricas a nivel de operación de GraphQL.

CloudWatch registros

Puede configurar dos tipos de registros en cada API de GraphQL nueva o existente, tanto en el nivel del campo como de la solicitud.

Registros en el nivel de la solicitud

Cuando se configura el registro en el nivel de solicitud (Incluir el contenido excesivamente detallado), se registra la información siguiente:

Registros en el nivel del campo

Cuando se configura el registro a nivel de campo, se registra la información siguiente:

Si activas el registro, AWS AppSync administra los CloudWatch registros. El proceso incluye la creación de grupos y flujos de registros, y la notificación a los flujos de registro con dichos registros.

Al activar el registro en una API de GraphQL y realizar solicitudes, AWS AppSync crea un grupo de registros y registra flujos en el grupo de registros. Al grupo de registro se le asigna un nombre con el formato /aws/appsync/apis/{graphql_api_id}. Dentro de cada grupo, los registros se dividen en flujos de registros. Estos se ordenan en función de la Last Event Time (Hora del último evento) según los datos registrados.

Cada evento de registro se etiqueta con el x-amzn- RequestId de esa solicitud. Esto le ayuda a filtrar los eventos de registro CloudWatch para obtener toda la información registrada sobre esa solicitud. Puedes obtenerlos RequestId de los encabezados de respuesta de cada solicitud de AWS AppSync GraphQL.

El registro en el nivel del campo se configura con los siguientes niveles de registro:

Ventajas de la supervisión

Puede utilizar el registro y las métricas para identificar, solucionar problemas y optimizar sus consultas de GraphQL. Por ejemplo, le pueden ayudar a depurar problemas de latencia mediante la información de seguimiento registrada para cada campo en la consulta. Para ver una demostración, suponga que utiliza uno o varios solucionadores anidados en una consulta de GraphQL. Un ejemplo de operación de campo en CloudWatch Logs podría tener un aspecto similar al siguiente:

{
    "path": [
        "singlePost",
        "authors",
        0,
        "name"
    ],
    "parentType": "Post",
    "returnType": "String!",
    "fieldName": "name",
    "startOffset": 416563350,
    "duration": 11247
}

Esto podría equivaler a un esquema de GraphQL, similar al siguiente:

type Post {
  id: ID!
  name: String!
  authors: [Author]
}

type Author {
  id: ID!
  name: String!
}

type Query {
  singlePost(id:ID!): Post
}

En los resultados del registro anterior, path muestra un solo elemento en los datos devueltos al ejecutar una consulta denominada singlePost(). En este ejemplo, representa el campo name en el primer índice (0). El valor de startOffset proporciona una demora desde el inicio de la operación de consulta de GraphQL. El valor de duration es el tiempo total necesario para resolver el campo. Estos valores pueden ser útiles para solucionar problemas relacionados con el motivo por el que un determinado origen de datos puede ejecutarse más lentamente de lo esperado, o si un campo específico está ralentizando toda la consulta. Por ejemplo, puede elegir aumentar el rendimiento aprovisionado de una tabla de Amazon DynamoDB o quitar un campo específico de una consulta que provoca que la ejecución vaya más lenta en general.

A partir del 8 de mayo de 2019, AWS AppSync genera eventos de registro en formato JSON completamente estructurado. Esto puede ayudarte a utilizar los servicios de análisis de CloudWatch registros, como Logs Insights y Amazon OpenSearch Service, para comprender el rendimiento de tus solicitudes de GraphQL y las características de uso de los campos de tu esquema. Por ejemplo, podrá identificar fácilmente solucionadores con latencias elevadas que podrían ser la causa de un problema de rendimiento. También podrá identificar los campos utilizados con mayor y menor frecuencia en su esquema y evaluar el impacto de dejar de usar campos de GraphQL.

Detección de conflictos y registro de sincronización

Si una AWS AppSync API tiene el registro de CloudWatch registros configurado con el nivel de registro de Field Resolver establecido en Todos, AWS AppSync emite información de detección y resolución de conflictos al grupo de registros. Esto proporciona información detallada sobre cómo respondió la AWS AppSync API a un conflicto. Para ayudarle a interpretar la respuesta, en los registros se proporciona la información siguiente:

Uso del recuento de tókenes para optimizar sus solicitudes

A las solicitudes que utilizan 1500 KB/s de memoria y tiempo de vCPU o menos se les asigna un token. Las solicitudes con un consumo de recursos superior a 1500 KB/s se les asignan más tókenes. Por ejemplo, si una solicitud consume 3.350 KB por segundo, AWS AppSync asigna tres fichas (redondeadas al siguiente valor entero) a la solicitud. De forma predeterminada, AWS AppSync asigna un máximo de 5000 o 10 000 fichas de solicitud por segundo a tu cuenta, en función de la región APIs en la que esté desplegada. AWS Si APIs cada uno de vosotros usa una media de dos fichas por segundo, tendréis un límite de 2500 o 5000 solicitudes por segundo, respectivamente. Si necesita más tókenes por segundo de lo que se le han asignado, puede enviar una solicitud para aumentar la cuota predeterminada de tókenes de solicitud. Para obtener más información, consulte AWS AppSync puntos finales y cuotas en la Referencia general de AWS guía y Solicitar un aumento de cuota en la Guía del usuario de Service Quotas.

Un número elevado de tókenes por solicitud podría indicar que existe la posibilidad de optimizar tus solicitudes y mejorar el rendimiento de su API. Entre los factores que pueden aumentar el número de tókenes por solicitud se incluyen los siguientes:

Límites de tamaño de registros

De forma predeterminada, si el registro está habilitado, AWS AppSync enviará hasta 1 MB de registros por solicitud. Los registros que superen este tamaño se truncarán. Para reducir el tamaño de los registros, elija el nivel de registro ERROR para los registros a nivel de campo y deshabilite el registro VERBOSE, o bien deshabilite por completo los registros a nivel de campo si no es necesario. Como alternativa al nivel de ALL registro, puede usar Enhanced Metrics para obtener métricas sobre resoluciones, fuentes de datos u operaciones de GraphQL específicas, o utilizar las utilidades de registro proporcionadas AppSync por para registrar solo la información necesaria.

Referencia de tipos de registros

RequestSummary

{
     "logType": "RequestSummary",
     "requestId": "dbe87af3-c114-4b32-ae79-8af11f3f96f1",
     "graphQLAPIId": "pmo28inf75eepg63qxq4ekoeg4",
     "statusCode": 200,
     "latency": 242000000
}

ExecutionSummary

{
    "duration": 217406145,
    "logType": "ExecutionSummary",
    "requestId": "dbe87af3-c114-4b32-ae79-8af11f3f96f1",
    "startTime": "2019-01-01T06:06:18.956Z",
    "endTime": "2019-01-01T06:06:19.174Z",
    "parsing": {
        "startOffset": 49033,
        "duration": 34784
    },
    "version": 1,
    "validation": {
        "startOffset": 129048,
        "duration": 69126
    },
    "graphQLAPIId": "pmo28inf75eepg63qxq4ekoeg4"
}

Rastreo

{
    "duration": 216820346,
    "logType": "Tracing",
    "path": [
        "putItem"
    ],
    "fieldName": "putItem",
    "startOffset": 178156,
    "resolverArn": "arn:aws:appsync:us-east-1:111111111111:apis/pmo28inf75eepg63qxq4ekoeg4/types/Mutation/fields/putItem",
    "requestId": "dbe87af3-c114-4b32-ae79-8af11f3f96f1",
    "parentType": "Mutation",
    "returnType": "Item",
    "graphQLAPIId": "pmo28inf75eepg63qxq4ekoeg4"
}

Analizar tus CloudWatch registros con Logs Insights

A continuación se muestran ejemplos de las consultas que puede ejecutar para obtener datos procesables sobre el rendimiento y el estado de las operaciones de GraphQL. Estos ejemplos están disponibles como consultas de muestra en la consola de CloudWatch Logs Insights. En la CloudWatchconsola, selecciona Logs Insights, selecciona el AWS AppSync grupo de registros para tu API de GraphQL y, a continuación, selecciona AWS AppSync consultas en Consultas de muestra.

La siguiente consulta devuelve las 10 solicitudes principales de GraphQL con que han usado el número máximo de tókenes:

filter @message like "Tokens Consumed"
| parse @message "* Tokens Consumed: *" as requestId, tokens
| sort tokens desc
| display requestId, tokens
| limit 10

La siguiente consulta devuelve los 10 solucionadores principales con latencia máxima:

  fields resolverArn, duration
| filter logType = "Tracing"
| limit 10
| sort duration desc

La siguiente consulta devuelve los solucionadores invocados con mayor frecuencia:

  fields ispresent(resolverArn) as isRes
| stats count() as invocationCount by resolverArn
| filter isRes and logType = "Tracing"
| limit 10
| sort invocationCount desc

La siguiente consulta devuelve los solucionadores con más errores en el mapeo de plantillas:

  fields ispresent(resolverArn) as isRes
| stats count() as errorCount by resolverArn, logType
| filter isRes and (logType = "RequestMapping" or logType = "ResponseMapping") and fieldInError
| limit 10
| sort errorCount desc

La siguiente consulta devuelve las estadísticas de latencia del solucionador:

  fields ispresent(resolverArn) as isRes
| stats min(duration), max(duration), avg(duration) as avg_dur by resolverArn
| filter isRes and logType = "Tracing"
| limit 10
| sort avg_dur desc

La siguiente consulta devuelve las estadísticas de latencia del campo:

  stats min(duration), max(duration), avg(duration) as avg_dur
  by concat(parentType, '/', fieldName) as fieldKey
| filter logType = "Tracing"
| limit 10
| sort avg_dur desc

Los resultados de las consultas de CloudWatch Logs Insights se pueden exportar a CloudWatch paneles.

Analice sus registros con Service OpenSearch

Puedes buscar, analizar y visualizar tus AWS AppSync registros con Amazon OpenSearch Service para identificar los cuellos de botella en el rendimiento y las causas fundamentales de los problemas operativos. Puede identificar los solucionadores con los errores y la latencia máxima. Además, puede usar los paneles para crear OpenSearch paneles con visualizaciones potentes. OpenSearch Dashboards es una herramienta de exploración y visualización de datos de código abierto disponible en Service. OpenSearch Con los OpenSearch paneles de control, puede supervisar de forma continua el rendimiento y el estado de sus operaciones de GraphQL. Por ejemplo, puede crear paneles que le permitan visualizar la latencia P90 de sus solicitudes de GraphQL y profundizar en las latencias P90 de cada solucionador.

Cuando utilices el OpenSearch Servicio, utiliza «cwl*» como patrón de filtro para buscar índices. OpenSearch OpenSearch El servicio indexa los registros transmitidos desde CloudWatch Logs con el prefijo «cwl-». Para diferenciar los registros de la AWS AppSync API de otros CloudWatch registros enviados al OpenSearch Servicio, te recomendamos añadir una expresión de graphQLAPIID.keyword=YourGraphQLAPIID filtro adicional a tu búsqueda.

Migración del formato de registro

Los eventos de registro que se AWS AppSync generen a partir del 8 de mayo de 2019 tienen el formato JSON completamente estructurado. Para analizar las solicitudes de GraphQL anteriores al 8 de mayo de 2019, puedes migrar los registros más antiguos a un JSON completamente estructurado mediante un script disponible en el GitHub ejemplo. Si necesita utilizar el formato del registro anterior al 8 de mayo de 2019, cree un tique de soporte técnico con la siguiente configuración: establezca Type (Tipo) en Account Management (Administración de cuentas) y, a continuación, establezca Category (Categoría) en General Account Question (Pregunta sobre la cuenta general).

También puedes usar filtros de métricas CloudWatch para convertir los datos de registro en CloudWatch métricas numéricas, de modo que puedas graficarlos o configurarlos como una alarma.