Come monitorare se un endpoint del gateway API è effettivamente raggiungibile

Sintomi problema

Potresti vedere uno o più dei seguenti sintomi:

• Nessun segnale di raggiungibilità diretta disponibile per un endpoint del gateway API.

• Le metriche del gateway API non mostrano una metrica dello stato dedicato.

• Le tendenze del volume di traffico, della latenza e del codice di risposta non confermano la durata degli endpoint.

• Nessun controllo dello stato OCI nativo configurato per l'endpoint di distribuzione del gateway API.

Cause possibili

La raggiungibilità dell'endpoint e le metriche del gateway misurano diverse parti del percorso della richiesta:

• I controlli dello stato indicano se è possibile raggiungere un percorso API distribuito dalla posizione di verifica del controllo dello stato.

• Le metriche del gateway API indicano il funzionamento del gateway dopo che il traffico ha raggiunto il gateway.

• Un gateway raggiungibile può comunque restituire un numero crescente di risposte 4xx o 5xx.

• Un gateway con poco o nessun traffico può avere pochi datapoint di metrica recenti, il che rende le metriche da sole un segnale di durata debole.

Configurare un controllo dello stato per la durata degli endpoint

Utilizzare i controlli dello stato quando è necessario un segnale binario o quasi binario che indica che un endpoint distribuito è raggiungibile.

Selezionare un instradamento API che soddisfi i seguenti requisiti:

• L'instradamento restituisce una risposta di successo prevedibile, ad esempio 200 o 204.

• L'instradamento non attiva i reindirizzamenti di accesso.

• L'instradamento non richiede credenziali per utente o parametri di query di breve durata.

• L'instradamento non esegue un'operazione di scrittura o crea un effetto lato business.

• L'instradamento rappresenta il percorso gateway API che si desidera monitorare.

Prima di creare il controllo dello stato, verificare manualmente l'instradamento:

curl -i https://<gateway-hostname>/<deployment-path-prefix>/<api-route-path>

Creare un controllo dello stato OCI per indirizzare l'endpoint distribuito esatto verificato. Utilizzare il controllo dello stato per i seguenti obiettivi di monitoraggio:

• Raggiungibilità endpoint.

• Controlli di disponibilità esterni.

• Avvisa quando l'endpoint non risponde con il codice di stato previsto.

Rivedi metriche gateway API

Utilizza le metriche del gateway API per comprendere i pattern di traffico e errori dopo che l'endpoint è raggiungibile. In Metrics Explorer, esaminare le metriche pubbliche del gateway API nello spazio di nomi oci_apigateway.

Iniziare con i parametri e le dimensioni riportati di seguito.

• HttpResponses, httpStatusCode e httpStatusCategory.

• BackendHttpResponses, backendHttpStatusCode e backendHttpStatusCategory.

• Latency, IntegrationLatency e InternalLatency.

• resourceId, deploymentId e route.

Utilizzare HttpResponses per esaminare i codici di stato restituiti dal gateway API. Utilizzare BackendHttpResponses per esaminare i codici di stato restituiti dai servizi backend.

Interpreta risultati monitoraggio

Utilizza lo stato del controllo dello stato e le metriche del gateway API insieme per identificare la posizione in cui si verifica il problema:

• Se il controllo dello stato non riesce, l'endpoint potrebbe non essere raggiungibile o non essere in buono stato dal percorso del test.

• Se il controllo dello stato riesce ma le risposte 4xx o 5xx aumentano, l'endpoint è raggiungibile ma le richieste non riescono.

• Se il traffico è basso e le metriche non mostrano dati recenti, i dati mancanti non dimostrano che il gateway non è disponibile.

• Se la raggiungibilità riesce ma la latenza aumenta, il gateway è raggiungibile ma l'elaborazione delle richieste potrebbe essere degradata.

Correggi lacune di monitoraggio

Utilizzare il segnale di monitoraggio corrispondente alla domanda a cui è necessario rispondere:

• Per monitorare la durata dell'endpoint, configurare i controlli dello stato per un instradamento API distribuito.

• Per analizzare il funzionamento delle risposte, esaminare le metriche del gateway API.

• Per monitorare sia la disponibilità che il comportamento, abbina i controlli dello stato alle metriche e agli allarmi del gateway API.

• Per evitare false conclusioni, non fare affidamento su una metrica del gateway API come indicatore di origine diretta del gateway.

Verifica monitoraggio endpoint

Dopo aver configurato il monitoraggio degli endpoint, verificare l'impostazione:

• Verificare che il percorso API selezionato restituisca il codice di stato previsto durante il test con curl.

• Confermare che il controllo dello stato OCI può eseguire il test dell'endpoint correttamente.

• Verificare che Metrics Explorer mostri gli andamenti delle richieste e delle risposte per il gateway.

• Verificare che gli allarmi distinguano i problemi di raggiungibilità degli endpoint dai problemi di codice di risposta o latenza.

Per ulteriori informazioni

Per ulteriori informazioni, fare riferimento agli argomenti sotto riportati.

• Controlli stato

• Creazione di un monitor HTTP

• Metriche gateway API