Utilizzo CloudWatch per monitorare e registrare i dati dell'API GraphQL

Le traduzioni sono generate tramite traduzione automatica. In caso di conflitto tra il contenuto di una traduzione e la versione originale in Inglese, quest'ultima prevarrà.

Le traduzioni sono generate tramite traduzione automatica. In caso di conflitto tra il contenuto di una traduzione e la versione originale in Inglese, quest'ultima prevarrà.

Puoi registrare ed eseguire il debug dell'API GraphQL CloudWatch utilizzando metriche CloudWatch e log. Questi strumenti consentono agli sviluppatori di monitorare le prestazioni, risolvere i problemi e ottimizzare efficacemente le operazioni GraphQL.

CloudWatch metrics è uno strumento che fornisce un'ampia gamma di metriche per monitorare le prestazioni e l'utilizzo delle API. Queste metriche si dividono in due categorie principali:

La guida introduce anche Enhanced Metrics, che offre dati più granulari sulle prestazioni dei resolver, sulle interazioni con le fonti di dati e sulle singole operazioni GraphQL. Queste metriche forniscono informazioni più approfondite ma comportano costi aggiuntivi.

CloudWatch Logs è uno strumento che abilita le funzionalità di registrazione per GraphQL. APIs I log possono essere impostati su due livelli dell'API:

È possibile configurare la registrazione, interpretare le voci di registro e utilizzare i dati di registro per la risoluzione dei problemi e l'ottimizzazione. AWS AppSync fornisce vari tipi di log che rivelano i dati di esecuzione, analisi, convalida e risoluzione del campo della query.

Installazione e configurazione

Per attivare la registrazione automatica su un'API GraphQL, usa AWS AppSync la console.

Configurazione manuale del ruolo IAM

Se scegli di utilizzare un ruolo IAM esistente, il ruolo deve concedere AWS AppSync le autorizzazioni necessarie per scrivere i log. CloudWatch Per configurarlo manualmente, è necessario fornire un ruolo di servizio ARN in modo che AWS AppSync possa assumere il ruolo durante la scrittura dei log.

Nella console IAM, crea una nuova policy con il nome AWSAppSyncPushToCloudWatchLogsPolicy che ha la seguente definizione:

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

Quindi, crea un nuovo ruolo con il nome AWSAppSyncPushToCloudWatchLogsRolee allega la policy appena creata al ruolo. Modifica la relazione di trust per questo ruolo nel modo seguente:

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

Copia il ruolo ARN e usalo quando configuri la registrazione per un'API AWS AppSync GraphQL.

CloudWatch metriche

Puoi utilizzare le CloudWatch metriche per monitorare e fornire avvisi su eventi specifici che possono causare codici di stato HTTP o latenza. Vengono emesse le seguenti metriche:

Abbonamenti in tempo reale

Tutte le metriche vengono emesse in un'unica dimensione: Graph. QLAPIId Ciò significa che tutte le metriche sono abbinate all'API GraphQL. IDs Le seguenti metriche sono relative agli abbonamenti GraphQL su pure: WebSockets

Confronto tra messaggi in entrata e in uscita

Quando viene eseguita una mutazione, vengono richiamati i campi di sottoscrizione con la direttiva @aws_subscribe per quella mutazione. Ogni chiamata di sottoscrizione genera un messaggio in entrata. Ad esempio, se due campi di sottoscrizione specificano la stessa mutazione in @aws_subscribe, quando viene chiamata la mutazione vengono generati due messaggi in entrata.

Un messaggio in uscita equivale a 5 kB di dati consegnati ai client. WebSocket Ad esempio, l'invio di 15 kB di dati a 10 client genera 30 messaggi in uscita (15 kB* 10 client/5 kB per messaggio = 30 messaggi).

È possibile richiedere aumenti delle quote per i messaggi in entrata o in uscita. Per ulteriori informazioni, consulta AWS AppSync endpoint e quote nella guida di riferimento AWS generale e le istruzioni per richiedere un aumento delle quote nella Service Quotas User Guide.

Metriche avanzate

Le metriche avanzate emettono dati granulari sull'utilizzo e sulle prestazioni delle API, come il conteggio delle AWS AppSync richieste e degli errori, la latenza e gli accessi non riusciti nella cache. Tutti i dati metrici avanzati vengono inviati al tuo CloudWatch account e puoi configurare i tipi di dati che verranno inviati.

Queste metriche sono disponibili in varie pagine di impostazioni della AWS AppSync console. Nella pagina delle impostazioni API, la sezione Enhanced Metrics consente di abilitare o disabilitare i seguenti elementi:

Comportamento delle metriche dei resolver: queste opzioni controllano il modo in cui vengono raccolte le metriche aggiuntive per i resolver. Puoi scegliere di abilitare le metriche complete dei resolver a richiesta (metriche abilitate per tutti i resolver presenti nelle richieste) o le metriche per resolver (metriche abilitate solo per i resolver in cui la configurazione è impostata come abilitata). Sono disponibili le seguenti opzioni:

Comportamento delle metriche delle origini dati: queste opzioni controllano il modo in cui vengono raccolte le metriche aggiuntive per le fonti di dati. Puoi scegliere di abilitare le metriche complete delle origini dati delle richieste (metriche abilitate per tutte le origini dati nelle richieste) o le metriche per origine dati (le metriche sono abilitate solo per le fonti di dati in cui la configurazione è impostata su abilitata). Sono disponibili le seguenti opzioni:

Metriche operative: abilita le metriche a livello operativo GraphQL.

CloudWatch registri

È possibile configurare due tipi di logging per qualsiasi API GraphQL nuova o esistente: a livello di richiesta e a livello di campo.

Registri a livello di richiesta

Quando è configurata la registrazione a livello di richiesta (include contenuti dettagliati), vengono registrate le seguenti informazioni:

Registri a livello di campo

Quando è configurata la registrazione a livello di campo, vengono registrate le seguenti informazioni:

Se si attiva la registrazione, AWS AppSync gestisce i registri. CloudWatch Il processo include la creazione di gruppi e flussi di log e la segnalazione di tali log ai flussi di log.

Quando attivi la registrazione su un'API GraphQL e fai richieste AWS AppSync , crea un gruppo di log e flussi di log all'interno del gruppo di log. Al gruppo di log viene assegnato un nome nel formato /aws/appsync/apis/{graphql_api_id}. In ogni gruppo di log, i log vengono ulteriormente suddivisi in flussi di log. Questi sono ordinati in base al valore Last Event Time (Ora ultimo evento) quando vengono segnalati i dati registrati.

Ogni evento di registro è contrassegnato con il codice x-amzn - di quella richiesta. RequestId Questo ti aiuta a filtrare gli eventi di registro CloudWatch per ottenere tutte le informazioni registrate su quella richiesta. Puoi ottenerlo RequestId dalle intestazioni di risposta di ogni richiesta AWS AppSync GraphQL.

Il logging a livello di campo è configurato con i livelli di log seguenti:

Vantaggi del monitoraggio

Puoi usare il logging e i parametri per identificare e ottimizzare le query GraphQL, oltre che per risolvere i relativi problemi. Puoi ad esempio eseguire il debug dei problemi di latenza usando le informazioni di traccia registrate per ogni campo nella query. Per dimostrare questo concetto, supponiamo di usare uno o più resolver annidati in una query GraphQL. Un esempio di operazione sul campo in CloudWatch Logs potrebbe essere simile alla seguente:

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

Ciò potrebbe corrispondere a uno schema GraphQL analogo a quanto segue:

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

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

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

Nei risultati del registro precedenti, path mostra un singolo elemento nei dati restituiti dall'esecuzione di una query denominata. singlePost() In questo esempio, rappresenta il campo del nome nel primo indice (0). Lo startOffset fornisce un offset dall'inizio dell'operazione di interrogazione GraphQL. La durata è il tempo totale per risolvere il campo. Questi valori possono essere utili per risolvere un problema a causa di cui i dati provenienti da un'origine dati specifica vengono eseguiti più lentamente del previsto oppure un campo specifico rallenta l'intera query. Ad esempio, puoi scegliere di aumentare il throughput assegnato per una tabella Amazon DynamoDB o rimuovere un campo specifico da una query che causa un cattivo funzionamento dell'operazione complessiva.

A partire dall'8 maggio 2019, AWS AppSync genera eventi di registro in formato JSON completamente strutturato. Questo può aiutarti a utilizzare servizi di analisi dei log come CloudWatch Logs Insights e Amazon OpenSearch Service per comprendere le prestazioni delle tue richieste GraphQL e le caratteristiche di utilizzo dei campi dello schema. Ad esempio, è possibile identificare in modo semplice i resolver con latenze di grandi dimensioni, possibile causa principale di un problema prestazionale. Inoltre, ora è possibile identificare i campi utilizzati più e meno frequentemente all’interno dello schema e valutare l'impatto di definire come obsoleti i campi GraphQL.

Rilevamento dei conflitti e registrazione della sincronizzazione

Se un' AWS AppSync API ha configurato la registrazione su CloudWatch Logs con il livello di registro Field resolver impostato su All, invia informazioni sul rilevamento e AWS AppSync la risoluzione dei conflitti al gruppo di log. Ciò fornisce informazioni dettagliate su come l'API ha risposto a un conflitto. AWS AppSync Per aiutarti a interpretare la risposta, nei log vengono fornite le seguenti informazioni:

Utilizzo del conteggio dei token per ottimizzare le richieste

Alle richieste che consumano meno o pari a 1.500 KB al secondo di memoria e tempo di vCPU viene allocato un token. Le richieste con un consumo di risorse superiore a 1.500 KB al secondo ricevono token aggiuntivi. Ad esempio, se una richiesta consuma 3.350 KB al secondo, AWS AppSync alloca tre token (arrotondati al valore intero successivo) alla richiesta. Per impostazione predefinita, AWS AppSync alloca un massimo di 5.000 o 10.000 token di richiesta al secondo APIs nel tuo account, a seconda della regione in cui viene distribuito. AWS Se APIs ognuno di voi utilizza una media di due token al secondo, sarete limitati a 2.500 o 5.000 richieste al secondo, rispettivamente. Se hai bisogno di più token al secondo rispetto all'importo assegnato, puoi inviare una richiesta per aumentare la quota predefinita per la frequenza di token di richiesta. Per ulteriori informazioni, consulta AWS AppSync Endpoint e quote nella Riferimenti generali di AWS guida e Richiesta di un aumento delle quote nella Service Quotas User Guide.

Un numero elevato di token per richiesta potrebbe indicare che esiste l'opportunità di ottimizzare le richieste e migliorare le prestazioni dell'API. I fattori che possono aumentare il numero di token per richiesta includono:

Limiti di dimensione del registro

Per impostazione predefinita, se la registrazione è stata abilitata, AWS AppSync invierà fino a 1 MB di log per richiesta. I log che superano questa dimensione verranno troncati. Per ridurre le dimensioni dei log, scegli il livello di registrazione per i ERROR log a livello di campo e disabilita la registrazione, oppure disabilita VERBOSE completamente i log a livello di campo se non necessario. In alternativa al livello di ALL log, puoi utilizzare Enhanced Metrics per ottenere metriche su resolver, fonti di dati o operazioni GraphQL specifici, oppure utilizzare le utilità di registrazione fornite da per registrare solo le informazioni necessarie. AppSync

Riferimento al tipo di registro

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

Tracciamento

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

Analisi CloudWatch dei log con Logs Insights

Di seguito sono elencati alcuni esempi di query che è possibile eseguire per ottenere informazioni dettagliate sulle prestazioni e lo stato delle operazioni GraphQL. Questi esempi sono disponibili come query di esempio nella console Logs Insights. CloudWatch Nella CloudWatchconsole, scegli Logs Insights, seleziona il gruppo di AWS AppSync log per la tua API GraphQL, quindi AWS AppSync scegli le query in Query di esempio.

La seguente query restituisce le prime 10 richieste GraphQL con il numero massimo di token consumati:

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

La query seguente restituisce i primi 10 resolver con latenza massima:

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

La query seguente restituisce i resolver richiamati più di frequente:

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

La query seguente restituisce i resolver con il maggior numero di errori nei modelli di mappatura:

  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 query seguente restituisce le statistiche di latenza dei resolver:

  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 query seguente restituisce le statistiche di latenza dei campi:

  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

I risultati delle query di CloudWatch Logs Insights possono essere esportati nei dashboard. CloudWatch

Analizza i tuoi log con Service OpenSearch

Puoi cercare, analizzare e visualizzare i tuoi AWS AppSync log con Amazon OpenSearch Service per identificare i punti deboli delle prestazioni e le cause principali dei problemi operativi. Puoi identificare i resolver con la latenza massima e gli errori. Inoltre, puoi utilizzare OpenSearch Dashboards per creare dashboard con visualizzazioni potenti. OpenSearch Dashboards è uno strumento open source di visualizzazione ed esplorazione dei dati disponibile in Service. OpenSearch Utilizzando OpenSearch le dashboard, puoi monitorare continuamente le prestazioni e lo stato delle tue operazioni GraphQL. Ad esempio, puoi creare dashboard per visualizzare la latenza P90 delle tue richieste GraphQL e approfondire le latenze P90 di ciascun resolver.

Quando usi OpenSearch Service, usa «cwl*» come modello di filtro per cercare gli indici. OpenSearch OpenSearch Il servizio indicizza i log trasmessi in streaming da CloudWatch Logs con il prefisso «cwl-». Per differenziare i log AWS AppSync delle API dagli altri CloudWatch registri inviati al OpenSearch Servizio, consigliamo di aggiungere un'espressione di filtro aggiuntiva di alla ricerca. graphQLAPIID.keyword=YourGraphQLAPIID

Migrazione del formato di registro

Gli eventi di registro AWS AppSync generati a partire dall'8 maggio 2019 sono formattati come JSON completamente strutturato. Per analizzare le richieste GraphQL prima dell'8 maggio 2019, puoi migrare i log più vecchi in JSON completamente strutturato utilizzando uno script disponibile nell'esempio. GitHub Se devi utilizzare il formato di log precedente all'8 maggio 2019, crea un ticket di supporto con le seguenti impostazioni: imposta Type (Tipo) su Account Management (Gestione account) e quindi imposta Category (Categoria) su General Account Question (Domanda account generale).

Puoi anche utilizzare i filtri metrici CloudWatch per trasformare i dati di registro in CloudWatch metriche numeriche, in modo da poterli rappresentare graficamente o impostare un allarme su di essi.