Metriche gateway API

Scopri le metriche emesse dal gateway API.

Puoi monitorare lo stato, la capacità e le prestazioni dei gateway e delle distribuzioni API gestiti dal servizio gateway API utilizzando le metriche , gli allarmi e le notifiche.

Questo argomento descrive le metriche emesse dal servizio gateway API nello spazio di nomi delle metriche oci_apigateway.

Risorse: gateway

Panoramica delle metriche del servizio gateway API

Le metriche del servizio Gateway API consentono di misurare le connessioni ai gateway API e la quantità di dati ricevuti e inviati dai gateway API. Puoi utilizzare i dati delle metriche per diagnosticare e risolvere i problemi relativi al gateway API e alla distribuzione delle API.

Mentre la frequenza varia in base alla metrica, le metriche di servizio predefinite in genere hanno una frequenza di 60 secondi, ovvero almeno un datapoint inviato al minuto.

Per visualizzare un set predefinito di grafici delle metriche nella console, accedere al gateway API a cui si è interessati, quindi selezionare Metriche. È inoltre possibile utilizzare il servizio di monitoraggio per creare query personalizzate. Vedere Creazione di query sulle metriche.

Prerequisiti

Criteri IAM: per monitorare le risorse, è necessario disporre del tipo di accesso richiesto in un criterio scritto da un amministratore, indipendentemente dal fatto che si stia utilizzando la console o l'API REST con un SDK, un'interfaccia CLI o un altro strumento. Il criterio deve consentire l'accesso sia ai servizi di monitoraggio che alle risorse monitorate. Se si tenta di eseguire un'azione e si riceve un messaggio che informa che non si dispone dell'autorizzazione o che non si è autorizzati, contattare l'amministratore per scoprire il tipo di accesso concesso e il compartimento in cui è necessario lavorare. Per ulteriori informazioni sulle autorizzazioni utente per il monitoraggio, vedere Criteri IAM.

Parametri disponibili: oci_apigateway

Le metriche elencate nelle tabelle seguenti sono automaticamente disponibili per qualsiasi gateway API creato. Non è necessario abilitare il monitoraggio sulla risorsa per ottenere queste metriche.

Le metriche del gateway API includono le dimensioni riportate di seguito.

RESOURCEID: OCID della risorsa a cui si applicano le metriche.
NOME RISORSA: Il nome della risorsa a cui vengono applicate le metriche.
DEPLOYMENTID: OCID della distribuzione API.
NOME DISTRIBUZIONE: Nome della distribuzione API.
PERCORSO: Percorso di instradamento per le chiamate API al servizio backend.
TIPO METODO HTTP: Metodi HTTP delle connessioni in entrata accettate dal servizio backend (ad esempio GET, HEAD, POST, PUT, DELETE).
HTTPSTATUSCODE: Codice di stato della risposta HTTP ricevuto dal gateway API (ad esempio 200, 201, 502, 504).
HTTPSTATUSCATEGORY: Categoria del codice di stato della risposta HTTP ricevuto dal gateway API (ad esempio 2xx, 3xx, 4xx, 5xx).
NOME BACKEND: Nome del backend (derivato dal nome della regola backend) a cui un gateway API instrada le richieste.
TIPO BACKEND: Il tipo di backend al quale un gateway API instrada le richieste a un servizio backend (ad esempio HTTP_BACKEND, ORACLE_FUNCTIONS_BACKEND, STOCK_RESPONSE_BACKEND).
BACKENDHTTPSTATUSCODE: Codice di stato della risposta HTTP ricevuto dal backend (ad esempio 200, 201, 502, 504).
BACKENDHTTPSTATUSCATEGORY: Categoria del codice di stato della risposta HTTP ricevuto dal backend (ad esempio 2xx, 3xx, 4xx, 5xx).
RISPECACHERESULT: L'azione intrapresa dalla cache delle risposte (una di HIT, MISS, BYPASS).
ENTLEMENTNAME: Il nome dell'abilitazione.
ID SOTTOSCRITTORE: L'OCID del sottoscrittore.
NOME SOTTOSCRITTORE: Il nome del destinatario predefinito.
NOME CLIENT: Nome del client di un sottoscrittore.
AZIONE: Azione intrapresa se il numero massimo di richieste nel periodo di tempo della quota spettante è stato superato.
ID PIANO DI UTILIZZO: OCID del piano di utilizzo.
NOME PIANO DI UTILIZZO: Nome del piano di utilizzo.


Parametro	Nome visualizzato metrica	Unità	descrizione	Dimensioni
`BytesReceived`	Byte ricevuti	byte	Numero di byte ricevuti dal gateway API dai client API.	`resourceId` `resourceName` `deploymentId` `deploymentName` `route` `httpMethodType` `httpStatusCode` `httpStatusCategory` `backendType`
`BytesSent`	Byte inviati	byte	Numero di byte inviati dal gateway API ai client API.	`resourceId` `resourceName` `deploymentId` `deploymentName` `route` `httpMethodType` `httpStatusCode` `httpStatusCategory` `backendType`
`HttpRequests`	Richieste API	conteggio	Numero di richieste client API in entrata al gateway API.	`resourceId` `resourceName` `deploymentId` `deploymentName` `route` `httpMethodType` `backendType` `backendName`
`HttpResponses`	Risposte API	Conteggio	Numero di risposte http inviate dal gateway API.	`resourceId` `resourceName` `deploymentId` `deploymentName` `route` `httpMethodType` `httpStatusCode` `httpStatusCategory` `backendType` `backendName`
`BackendHttpResponses`	Risposte backend	Conteggio	Conteggio delle risposte HTTP restituite dai servizi backend.	`resourceId` `resourceName` `deploymentId` `deploymentName` `route` `httpMethodType` `httpStatusCode` `httpStatusCategory` `backendType` `backendName` `backendHttpStatusCode` `backendHttpStatusCategory`
`Latency`	Latenza gateway	secondi	Tempo impiegato per l'elaborazione di una richiesta e la relativa risposta da inviare. Questo valore viene calcolato dal momento in cui il gateway API riceve il primo byte di una richiesta HTTP al momento in cui viene completata l'operazione di invio della risposta. Latenza è la somma di Latenza di integrazione e Latenza interna.	`resourceId` `resourceName` `deploymentId` `deploymentName` `route` `httpMethodType` `httpStatusCode` `httpStatusCategory` `backendType`
`IntegrationLatency`	Latenza integrazione	secondi	Tempo impiegato dal gateway API per richiamare le integrazioni esterne (ad esempio backend HTTP, funzioni OCI, DNS e server di autenticazione).	`resourceId` `resourceName` `deploymentId` `deploymentName` `route` `httpMethodType` `httpStatusCode` `httpStatusCategory` `backendType`
`InternalLatency`	Latenza interna	secondi	Tempo trascorso internamente al gateway API per l'elaborazione della richiesta.	`resourceId` `resourceName` `deploymentId` `deploymentName` `route` `httpMethodType` `httpStatusCode` `httpStatusCategory`
`ResponseCacheAction`	Azioni cache risposte	Conteggio	L'azione eseguita dalla cache delle risposte.	`resourceId` `resourceName` `deploymentId` `deploymentName` `route` `responseCacheResult`
`ResponseCacheAvailability`	Disponibilità cache delle risposte	Conteggio	Disponibilità della cache delle risposte come viene visualizzata dal gateway API.	`resourceId` `resourceName`
`ResponseCacheLatency`	Latenza cache delle risposte	millisecondi	Tempo totale necessario per le operazioni di connessione, lettura e memorizzazione nella cache delle risposte.	`resourceId` `resourceName` `deploymentId` `deploymentName` `route`
`UsagePlanRequests`	Richieste piani di utilizzo	Sum	Numero di richieste a una determinata abilitazione. Emesso per richiesta.	`resourceId` `resourceName` `entitlementName` `subscriberId` `subscriberName` `clientName` `action`
`SubscriberRequests`	Richieste dei sottoscrittori	Sum	Numero di richieste eseguite da un sottoscrittore. Emesso per richiesta.	`resourceId` `resourceName` `clientName` `usagePlanId` `usagePlanName` `entitlementName` `action`
`SubscriberQuotaProportionUsed`	Proporzione della quota sottoscrittori usata	Media	Percentuale di quota di un'abilitazione consumata da un sottoscrittore. Emesso per richiesta. Calcolato come: `<current number of requests this period> / <quota for entitlement this period>`	`resourceId` `resourceName` `clientName` `usagePlanId` `usagePlanName` `entitlementName`
`SubscriberRateLimitProportionUsed`	Proporzione del limite di frequenza dei sottoscrittori usata	Media	Percentuale del limite di frequenza di un'abilitazione che è stata utilizzata da un sottoscrittore. Emesso per richiesta. Calcolato come: `<current number of requests this period> / <rate limit for entitlement this period>`	`resourceId` `resourceName` `clientName` `usagePlanId` `usagePlanName` `entitlementName`

Uso della console

Per visualizzare i grafici delle metriche predefiniti per un singolo gateway API

Nella pagina della lista Gateway selezionare il gateway API per il quale si desidera visualizzare le metriche. Se hai bisogno di assistenza per trovare la pagina della lista o il gateway API, consulta Elenco dei gateway API.
In Risorse, selezionare Metriche.

La pagina Metriche visualizza un grafico per ogni metrica emessa dallo spazio di nomi delle metriche per il gateway API. Per ulteriori informazioni sulle metriche emesse, vedere Metriche disponibili: oci_apigateway.

Per ulteriori informazioni sulle metriche di monitoraggio e sull'uso degli allarmi, vedere Panoramica del monitoraggio. Per informazioni sulle notifiche per gli allarmi, vedere Panoramica delle notifiche.

I dati delle metriche del gateway API previsti non vengono visualizzati?

Se non vengono visualizzati i dati delle metriche per un gateway API previsto, vedere le possibili cause e risoluzioni riportate di seguito.


problema	Causa possibile	Modalità di verifica	Risoluzione
Ho chiamato un'API distribuita in un gateway API, ma il grafico Richieste HTTP non mostra la chiamata API.	Potresti aver chiamato l'API al di fuori del periodo di tempo coperto dal grafico Richieste HTTP.	Confermare l'ora di inizio e l'ora di fine per coprire il periodo in cui è stata chiamata l'API.	Modificare le opzioni Ora di inizio e Ora di fine in base alle esigenze.
Ho chiamato un'interfaccia API distribuita in un gateway API, ma il grafico Richieste HTTP non mostra la chiamata API, anche se ho chiamato l'interfaccia API tra l'ora di inizio e l'ora di fine.	Sebbene l'interfaccia API sia stata definita tra l'ora di inizio e l'ora di fine, è possibile che l'asse x (finestra di visualizzazione dei dati) escluda la chiamata all'interfaccia API.	Verificare che l'asse x (finestra di visualizzazione dei dati) copra il periodo di chiamata dell'interfaccia API.	Se necessario, regolare l'asse x (finestra di visualizzazione dei dati).
Voglio vedere i dati nei grafici come una linea continua nel tempo, ma la linea ha delle lacune.	Si tratta di un comportamento conosciuto. Se non sono presenti dati delle metriche da visualizzare nell'intervallo selezionato, la linea dati è discontinua.	Aumentare l'intervallo (ad esempio, da 1 minuto a 5 minuti o da 1 minuto a 1 ora).	Adeguare l'intervallo in base alle esigenze.

Per visualizzare i grafici delle metriche predefiniti per tutti i gateway API in un compartimento

Aprire il menu di navigazione e selezionare Osservabilità e gestione. In Monitoraggio, selezionare Metriche servizio.
Selezionare l'area in uso con il gateway API
Selezionare il compartimento contenente i gateway API per i quali si desidera visualizzare le metriche.
Per Spazio di nomi metrica, selezionare oci_apigateway.

La pagina Metriche servizio aggiorna in modo dinamico la pagina in modo da visualizzare i grafici per ogni metrica emessa dallo spazio di nomi della metrica selezionata. Per ulteriori informazioni sulle metriche emesse, vedere Metriche disponibili: oci_apigateway.

Per ulteriori informazioni sulle metriche di monitoraggio e sull'uso degli allarmi, vedere Panoramica del monitoraggio. Per informazioni sulle notifiche per gli allarmi, vedere Panoramica delle notifiche.

Utilizzo dell'API

Per informazioni sull'uso dell'API e delle richieste di firma, consulta la documentazione dell'API REST e le credenziali di sicurezza. Per informazioni sugli SDK, vedere SDK e l'interfaccia CLI.

Utilizzare le seguenti API per il monitoraggio:

Monitoraggio dell'API per metriche e allarmi
API Notifiche per le notifiche (utilizzata con gli allarmi)