Esercitazione: Monitorare le API pubblicate

SI APPLICA A: Tutti i livelli di Gestione API

Con Monitoraggio di Azure è possibile eseguire operazioni di visualizzazione, query, instradamento, archiviazione, e quindi adottare le misure appropriate, sulle metriche o sui log provenienti dal servizio Gestione API. Per una panoramica di Monitoraggio di Azure per Gestione API, vedere Monitorare Gestione API.

In questa esercitazione apprenderai a:

Prerequisiti

• Acquisire familiarità con la terminologia di Gestione API di Azure.
• Completare la guida introduttiva seguente: Creare un'istanza di Gestione API di Azure.
• Completare anche l'esercitazione seguente: Importare e pubblicare la prima API.

Visualizzare le metriche delle API

Gestione API genera le metriche ogni minuto in modo da ottenere una visibilità near real-time dello stato e dell'integrità delle API. Di seguito sono riportate le metriche usate più di frequente. Per un elenco di tutte le metriche disponibili, vedere Metriche.

• Capacità: consente di decidere se eseguire l'aggiornamento o il downgrade dei servizi di Gestione API. La metrica viene emessa ogni minuto e riflette la capacità del gateway stimate al momento in cui viene eseguito il report. La metrica è compresa tra 0 e 100 e viene calcolata in base alle risorse gateway, come utilizzo della CPU e della memoria e altri fattori.

  Suggerimento

  Nei livelli di servizio v2 e nei gateway dell'area di lavoro, Gestione API ha sostituito la metrica della capacità del gateway con metriche di utilizzo della CPU e della memoria separate. Queste metriche possono essere usate anche per decisioni di ridimensionamento e risoluzione dei problemi. Ulteriori informazioni

• Richieste: consente di analizzare il traffico dell'API che transitano attraverso i servizi di Gestione API. La metrica viene generata al minuto e segnala il numero di richieste di gateway con dimensioni. Filtrare le richieste in base a codici di risposta, posizione, nome host ed errori.

Per accedere alle metriche:

1. Nel portale di Azure accedere all'istanza di Gestione API. Nella pagina di panoramica, nella scheda Monitoraggio esaminare le metriche chiave per le API.

2. Per analizzare in dettaglio le metriche, selezionare Monitoraggio>metriche dal menu a sinistra.

   

   Suggerimento

   In un'area di lavoro, puoi visualizzare le metriche di capacità legate a un gateway dell'area di lavoro. Passare a Monitoraggio>Metriche nel menu a sinistra di un gateway dell'area di lavoro.

3. Dall'elenco a discesa selezionare le metriche desiderate. Ad esempio, Richieste.

4. Il grafico mostra il numero totale di chiamate API. Regolare l'intervallo di tempo per concentrarsi sui periodi di interesse.

5. È possibile filtrare il grafico usando le dimensioni della metrica Richieste . Ad esempio, selezionare Aggiungi filtro, quindi selezionare Backend Response Code Category (Categoria codice di risposta back-end) e immettere 500 come valore. Il grafico mostra ora il numero di richieste non riuscite nel back-end dell'API.

Configurare una regola di avviso

È possibile ricevere gli avvisi in base alle metriche e ai log attività. In Monitoraggio di Azure, configurare una regola di avviso per eseguire un'azione quando viene attivata. Le azioni comuni includono:

• Inviare una notifica tramite posta elettronica
• Chiamare un webhook
• Richiamare un'app per la logica di Azure

Per configurare una regola di avviso di esempio in base a una metrica della richiesta:

1. Nel portale di Azure accedere all'istanza di Gestione API.

2. Selezionare Monitoraggio>avvisi dal menu a sinistra.

   

3. Selezionare + Crea>Regola di avviso.

4. Nella scheda Condizione :

   1. Selezionare Richieste per Nome segnale.
   2. In Logica di avviso esaminare o modificare i valori predefiniti per l'avviso. Ad esempio, aggiornare la soglia statica, ovvero il numero di occorrenze dopo cui deve essere attivato l'avviso.
   3. In Dividi per dimensioni, in Nome dimensione selezionare Gateway Response Code Category (Categoria codice di risposta del gateway).
   4. In Valori di dimensione selezionare 4xx per gli errori client come le richieste non autorizzate o non valide. Se il valore della dimensione non viene visualizzato, selezionare Aggiungi valore personalizzato e immettere 4xx.
   5. In Quando valutare, accettare le impostazioni predefinite o selezionare altre impostazioni per configurare la frequenza di esecuzione della regola. Selezionare Avanti.

   

5. Nella scheda Azioni, selezionare o creare uno o più gruppi di azioni per notificare agli utenti l'avviso ed eseguire un'azione. Ad esempio, creare un nuovo gruppo di azioni per inviare un messaggio di posta elettronica di notifica a admin@contoso.com. Per i passaggi dettagliati, vedere Creare e gestire gruppi di azioni nel portale di Azure.

   

6. Nella scheda Dettagli di Crea una regola di avviso, immettere un nome e una descrizione della regola di avviso e selezionare il livello di gravità.

7. Facoltativamente, configurare le impostazioni rimanenti. Quindi, nella scheda Rivedi e crea, selezionare Crea.

8. Facoltativamente, testare la regola di avviso usando un client HTTP per simulare una richiesta che attiva l'avviso. Ad esempio, eseguire il comando seguente in un terminale sostituendo il nome host Gestione API con il nome host dell'istanza di Gestione API:

   curl GET https://contoso.azure-api.net/non-existent-endpoint HTTP/1.1 
   

   Un avviso si attiva in base al periodo di valutazione e invierà un messaggio di posta elettronica a admin@contoso.com.

   Gli avvisi vengono visualizzati anche nella pagina Avvisi per l'istanza di Gestione API.

   

Log attività

I log attività offrono informazioni dettagliate sulle operazioni sui servizi Gestione API. L'uso del log attività consente di acquisire informazioni dettagliate su qualsiasi operazione di scrittura (PUT, POST, DELETE) eseguita sui servizi Gestione API.

È possibile accedere ai log attività del servizio Gestione API o ai log di tutte le risorse di Azure in Monitoraggio di Azure.

Per visualizzare il log attività:

1. Nel portale di Azure accedere all'istanza di Gestione API.

2. Selezionare Log attività.

   

3. Selezionare l'ambito di filtro desiderato e fare clic su Applica.

Log risorse

I log delle risorse (log di Monitoraggio di Azure) forniscono informazioni dettagliate sulle operazioni e sugli errori di Gestione API importanti per scopi di controllo e risoluzione dei problemi. Se abilitata tramite un'impostazione di diagnostica, i log raccolgono informazioni sulle richieste API ricevute ed elaborate dal gateway di Gestione API.

Per configurare un'impostazione di diagnostica per la raccolta di log delle risorse:

1. Nel portale di Azure accedere all'istanza di Gestione API.

2. Nel riquadro del menu centrale, in Monitoraggio selezionare Impostazioni di diagnostica>+ Aggiungi impostazione di diagnostica.

   

3. Nella pagina Impostazione diagnostica immettere o selezionare i dettagli per l'impostazione:

   1. Nome dell'impostazione di diagnostica: immettere un nome descrittivo.
   2. Gruppi di categorie: facoltativamente, effettuare una selezione per lo scenario.
   3. In Categorie: selezionare una o più categorie. Ad esempio, selezionare Log correlati a ApiManagement Gateway per raccogliere i log per la maggior parte delle richieste al gateway di Gestione API.
   4. In Dettagli destinazioneselezionare una o più opzioni e specificare i dettagli per la destinazione. Ad esempio, inviare i log a un'area di lavoro Log Analytics di Azure, archiviare i log a un account di archiviazione o trasmetterli a un hub eventi. Per altre informazioni, vedere Impostazioni di diagnostica in Monitoraggio di Azure.
   5. Seleziona Salva.

   Suggerimento

   • Per visualizzare l'analisi api nel dashboard basato su Monitoraggio di Azure per Gestione API (pannello Analisi di monitoraggio>), selezionare un'area di lavoro Log Analytics di Azure come destinazione.
   • Se si seleziona un'area di lavoro Log Analytics, è possibile scegliere di archiviare i dati in una tabella specifica della risorsa (ad esempio, una tabella ApiManagementGatewayLogs) o archiviarli nella tabella generale di AzureDiagnostics. È consigliabile usare la tabella specifica della risorsa per le destinazioni di log che la supportano. Ulteriori informazioni

4. Dopo aver configurato i dettagli per le destinazioni o la destinazioni del log, selezionare Salva.

Visualizzare log e metriche in Azure Log Analytics

Se si abilita la raccolta di log o metriche in un'area di lavoro Log Analytics, la visualizzazione dei dati in Monitoraggio di Azure e del dashboard basato su Monitoraggio di Azure per Gestione API (pannelloAnalisi di monitoraggio>) può richiedere alcuni minuti.

Per visualizzare i dati:

1. Nel portale di Azure accedere all'istanza di Gestione API.

2. Nel menu a sinistra, in Monitoraggio, selezionare Log.

3. Eseguire query per visualizzare i dati. Sono disponibili numerose query di esempio oppure eseguire una query personalizzata. Ad esempio, la query seguente recupera le ultime 24 ore di dati dalla tabella ApiManagementGatewayLogs:

   ApiManagementGatewayLogs
   | where TimeGenerated > ago(1d) 
   

   

Per altre informazioni sull'utilizzo dei log delle risorse per Gestione API, vedere:

• Esercitazione su Log Analytics.
• Panoramica delle query su log in Monitoraggio di Azure.

Modificare le impostazioni di registrazione API

Quando si usa il portale per creare un'impostazione di diagnostica per abilitare la raccolta di log del gateway di Gestione API o del gateway di intelligenza artificiale generativo, la registrazione è abilitata con le impostazioni predefinite. Le impostazioni predefinite non includono i dettagli delle richieste o delle risposte, ad esempio i corpi di richiesta o risposta. È possibile modificare le impostazioni di registrazione per tutte le API o eseguirne l'override per le singole API. Ad esempio, modificare la frequenza di campionamento o il livello di dettaglio dei dati del log del gateway, abilitare la registrazione dei messaggi di richiesta o risposta LLM o disabilitare la registrazione per alcune API.

Per informazioni dettagliate sulle impostazioni di registrazione, vedere le pagine di riferimento diagnostica - Creazione o aggiornamento e diagnostica API - Creare o aggiornare l'API REST.

Per configurare le impostazioni di registrazione per tutte le API:

1. Nel menu a sinistra dell'istanza di Gestione API selezionare >>
2. Selezionare la scheda Impostazioni dalla barra in alto.
3. Scorrere verso il basso fino alla sezione Log di diagnostica e selezionare la scheda Monitoraggio di Azure.
4. Esaminare le impostazioni e apportare modifiche, se necessario. Seleziona Salva.

Per configurare le impostazioni di registrazione per un'API specifica:

1. Nel menu a sinistra dell'istanza di Gestione API selezionare API> e quindi il nome dell'API.
2. Selezionare la scheda Impostazioni dalla barra in alto.
3. Scorrere verso il basso fino alla sezione Log di diagnostica e selezionare la scheda Monitoraggio di Azure.
4. Esaminare le impostazioni e apportare modifiche, se necessario. Seleziona Salva.

Passaggi successivi

Questa esercitazione ha descritto come:

Passare all'esercitazione successiva: