Monitorare Gestione API
SI APPLICA A: Tutti i livelli di Gestione API
Monitoraggio di Azure raccoglie e aggrega metriche e log dal sistema per monitorare la disponibilità, le prestazioni e la resilienza e notificare eventuali problemi che interessano il sistema. È possibile usare il portale di Azure, PowerShell, l'interfaccia della riga di comando di Azure, l'API REST o le librerie client per configurare e visualizzare i dati di monitoraggio.
Sono disponibili metriche e log diversi per diversi tipi di risorse. Questo articolo descrive i tipi di dati di monitoraggio che è possibile raccogliere per questo servizio e i modi per analizzare tali dati.
Raccogliere dati con Monitoraggio di Azure
Questa tabella descrive come raccogliere i dati per monitorare il servizio e le operazioni che è possibile eseguire con i dati dopo la raccolta:
| Dati da raccogliere | Descrizione | Come raccogliere e instradare i dati | Dove visualizzare i dati | Dati supportati |
|---|---|---|---|---|
| Dati delle metriche | Le metriche sono valori numerici che descrivono determinati aspetti di un sistema in un particolare momento. Le metriche possono essere aggregate usando algoritmi, rispetto ad altre metriche e analizzate per individuare le tendenze nel tempo. | - Raccolto automaticamente a intervalli regolari. - È possibile instradare alcune metriche della piattaforma a un'area di lavoro Log Analytics per eseguire query con altri dati. Controllare l'impostazione di esportazione DS per ogni metrica per verificare se è possibile usare un'impostazione di diagnostica per instradare i dati delle metriche. |
Esplora metriche | Metriche di Gestione API di Azure supportate da Monitoraggio di Azure |
| Dati del log delle risorse | I log vengono registrati eventi di sistema con un timestamp. I log possono contenere tipi diversi di dati e possono essere strutturati o in formato libero. È possibile instradare i dati del log delle risorse alle aree di lavoro Log Analytics per l'esecuzione di query e l'analisi. | Creare un'impostazione di diagnostica per raccogliere e instradare i dati del log delle risorse. | Log Analytics | Azure Gestione API dati di log delle risorse supportati da Monitoraggio di Azure |
| Dati del log attività | Il log attività di Monitoraggio di Azure fornisce informazioni dettagliate sugli eventi a livello di sottoscrizione. Il log attività include informazioni relative, ad esempio, alla modifica di una risorsa o all'avvio di una macchina virtuale. | - Raccolto automaticamente. - Creare un'impostazione di diagnostica per un'area di lavoro Log Analytics senza costi aggiuntivi. |
Log attività |
Per l'elenco di tutti i dati supportati da Monitoraggio di Azure, vedere:
Monitoraggio integrato per Gestione API
Gestione API di Azure include le funzionalità di monitoraggio predefinite seguenti.
Ottenere analisi API in Gestione API di Azure
Gestione API di Azure offre analitica per le API in modo da poter analizzare l'utilizzo e le prestazioni. Usare l'analisi per il monitoraggio generale e la risoluzione dei problemi delle API. Per altre funzionalità di monitoraggio, incluse le metriche near real-time e i log delle risorse per la diagnostica e il controllo, vedere Esercitazione: monitorare le API pubblicate.
Nota
Attualmente, questa funzionalità non è disponibile nelle aree di lavoro.
- Gestione API fornisce analisi usando un dashboard basato su Monitoraggio di Azure. Il dashboard aggrega i dati in un'area di lavoro Log Analytics di Azure.
- Nei livelli di servizio di Gestione API classica, l'istanza di Gestione API include anche analisi predefinite nel portale di Azure e i dati di analisi sono accessibili usando l'API REST di Gestione API. Dati molto simili vengono visualizzati nel dashboard basato su Monitoraggio di Azure e nell'analisi predefinita.
Importante
Il dashboard basato su Monitoraggio di Azure è il modo consigliato per accedere ai dati analitici. L'analisi predefinita (classica) non è disponibile nei livelli v2.
Con le analisi delle API, analizzare l'utilizzo e le prestazioni delle API nell'istanza di Gestione API su diverse dimensioni, tra cui:
- Time
- Geografia
- API
- Operazioni API
- Prodotti
- Sottoscrizioni
- Utenti
- Richieste
Le analisi delle API forniscono dati sulle richieste, incluse le richieste non riuscite e non autorizzate. I valori geography sono basati sul mapping degli indirizzi IP. Può verificarsi un ritardo nella disponibilità dei dati di analisi.
Dashboard basato su Monitoraggio di Azure
Per usare il dashboard basato su Monitoraggio di Azure, è necessaria un'area di lavoro Log Analytics come origine dati per i log del gateway di Gestione API.
Se è necessario configurarne una, di seguito sono riportati alcuni passaggi per inviare i log del gateway a un'area di lavoro Log Analitica. Per altre informazioni, vedere Esercitazione: Monitorare le API pubblicate. Questa procedura è una configurazione monouso.
- Nel portale di Azure accedere all'istanza di Gestione API.
- Nel riquadro del menu centrale, in Monitoraggio selezionare Impostazioni di diagnostica>+ Aggiungi impostazione di diagnostica.
- Immettere un nome descrittivo per l'impostazione di diagnostica.
- In Log selezionare Log correlati ad ApiManagement Gateway.
- In Dettagli destinazione selezionare Invia a Log Analytics e selezionare un'area di lavoro Log Analytics nella stessa sottoscrizione o in una sottoscrizione diversa. Se è necessario creare un'area di lavoro, vedere Creare un'area di lavoro Log Analytics.
- Assicurarsi che l'opzione Specifica della risorsa sia selezionata come tabella di destinazione.
- Seleziona Salva.
Importante
Per iniziare a ricevere dati, una nuova area di lavoro Log Analytics può richiedere fino a 2 ore. Un'area di lavoro esistente deve iniziare a ricevere i dati entro circa 15 minuti.
Accedere al dashboard
Dopo aver configurato un'area di lavoro Log Analytics, accedere al dashboard basato su Monitoraggio di Azure per analizzare l'utilizzo e le prestazioni delle API.
- Nel portale di Azure accedere all'istanza di Gestione API.
- Nel menu a sinistra, in Monitoraggio selezionare Analisi. Verrà aperto il dashboard di analisi.
- Selezionare un intervallo di tempo per i dati.
- Selezionare una categoria di report per i dati di analisi, ad esempio Sequenza temporale, Geografia e così via.
Analitica predefinita legacy
In alcuni livelli di servizio Gestione API, è disponibile anche l'analisi predefinita (chiamata anche analisi legacy o analisi classica) nel portale di Azure e i dati di analisi sono accessibili usando l'API REST di Gestione API.
Per accedere alle analisi predefinite (versione classica) nel portale di Azure:
- Nel portale di Azure accedere all'istanza di Gestione API.
- Nel menu a sinistra, in Monitoraggio selezionare Analisi (versione classica).
- Selezionare un intervallo di tempo per i dati, o immettere un intervallo di tempo personalizzato.
- Selezionare una categoria di report per i dati di analisi, ad esempio Sequenza temporale, Geografia e così via.
- Facoltativamente, filtrare il report in base a una o più categorie aggiuntive.
Usare le operazioni dei report dell'API REST di Gestione API per recuperare e filtrare i dati di analisi per l'istanza di Gestione API.
Le operazioni disponibili restituiscono record di report in base all'API, all'area geografica, alle operazioni API, al prodotto, alla richiesta, alla sottoscrizione, all'ora o all'utente.
Abilitare la registrazione dell'utilizzo del portale per sviluppatori in Gestione API di Azure
Questa sezione illustra come abilitare i log di Monitoraggio di Azure per il controllo e la risoluzione dei problemi di utilizzo del portale per sviluppatori Gestione API. Se abilitata tramite un'impostazione di diagnostica, i log raccolgono informazioni sulle richieste ricevute ed elaborate nel portale per sviluppatori.
I log di utilizzo del portale per sviluppatori includono dati sull'attività nel portale per sviluppatori, tra cui:
- Azioni di autenticazione utente, ad esempio accesso e disconnesso
- Visualizzazioni dei dettagli dell'API, dei dettagli dell'operazione API e dei prodotti
- Test api nella console di test interattiva
Abilitare l'impostazione di diagnostica per i log del portale per sviluppatori
Per configurare un'impostazione di diagnostica per i log di utilizzo del portale per sviluppatori:
Nel portale di Azure accedere all'istanza di Gestione API.
Nel riquadro del menu centrale, in Monitoraggio selezionare Impostazioni di diagnostica>+ Aggiungi impostazione di diagnostica.
Nella pagina Impostazione diagnostica immettere o selezionare i dettagli per l'impostazione:
- Nome dell'impostazione di diagnostica: immettere un nome descrittivo.
- Gruppi di categorie: facoltativamente, effettuare una selezione per lo scenario.
- In Categorie: selezionare Log correlati all'utilizzo del portale per sviluppatori. Facoltativamente, selezionare altre categorie in base alle esigenze.
- In Dettagli destinazioneselezionare una o più opzioni e specificare i dettagli per la destinazione. Ad esempio, archiviare i log in un account di archiviazione o trasmetterli a un hub eventi. Per altre informazioni, vedere Impostazioni di diagnostica in Monitoraggio di Azure.
- Seleziona Salva.
Visualizzare i dati del log di diagnostica
A seconda della destinazione del log scelta, la visualizzazione dei dati può richiedere alcuni minuti.
Se si inviano log a un account di archiviazione, è possibile accedere ai dati nel portale di Azure e scaricarli per l'analisi.
- Nel portale di Azure andare alla destinazione dell'account di archiviazione.
- Nel menu a sinistra selezionare Browser archiviazione.
- In Contenitori BLOBselezionare insights-logs-developerportalauditlogs.
- Passare al contenitore per i log nell'istanza di Gestione API. I log vengono partizionati in intervalli di 1 ora.
- Per recuperare i dati per ulteriori analisi, selezionare Scarica.
Usare gli strumenti di Monitoraggio di Azure per analizzare i dati
Questi strumenti di Monitoraggio di Azure sono disponibili nella portale di Azure per analizzare i dati di monitoraggio:
Alcuni servizi di Azure hanno un dashboard di monitoraggio predefinito nella portale di Azure. Questi dashboard sono denominati informazioni dettagliate ed è possibile trovarli nella sezione Insights di Monitoraggio di Azure nella portale di Azure.
Esplora metriche consente di visualizzare e analizzare le metriche per le risorse di Azure. Per altre informazioni, vedere Analizzare le metriche con Esplora metriche di Monitoraggio di Azure.
Log Analytics consente di eseguire query e analizzare i dati di log usando il linguaggio di query Kusto (KQL). Per altre informazioni, vedere Introduzione alle query dei log del Monitoraggio di Azure.
Il portale di Azure dispone di un'interfaccia utente per la visualizzazione e le ricerche di base del log attività. Per eseguire analisi più approfondite, indirizzare i dati ai log di Monitoraggio di Azure ed eseguire query più complesse in Log Analytics.
Application Insights monitora la disponibilità, le prestazioni e l'utilizzo delle applicazioni Web, in modo da poter identificare e diagnosticare gli errori senza attendere che un utente li segnala.
Application Insights include punti di connessione a vari strumenti di sviluppo e si integra con Visual Studio per supportare i processi DevOps. Per altre informazioni, vedere Monitoraggio delle applicazioni per il Servizio app.
Gli strumenti che consentono una visualizzazione più complessa includono:
- I dashboard che consentono di combinare tipi di dati diversi in un singolo riquadro nel portale di Azure.
- Cartelle di lavoro, report personalizzabili che è possibile creare nel portale di Azure. Le cartelle di lavoro possono includere testo, metriche e query di log.
- Grafana è una piattaforma aperta, ideale per i dashboard operativi. È possibile usare Grafana per creare dashboard che includano dati da più origini diverse dal Monitoraggio di Azure.
- Power BI, un servizio di analisi aziendale che fornisce visualizzazioni interattive per un'ampia varietà di origini dati. È possibile configurare per Power BI per importare automaticamente i dati di log da Monitoraggio di Azure per sfruttare i vantaggi di queste visualizzazioni.
Visualizzare i dati di monitoraggio di Gestione API usando un dashboard Grafana gestito
È possibile usare Grafana con gestione Azure per visualizzare i dati di monitoraggio di API Management raccolti in un'area di lavoro Log Analytics. Usare un dashboard predefinito di API Management per visualizzare in tempo reale i log e le metriche raccolti dall'istanza di API Management.
- Altre informazioni su Grafana con gestione Azure
- Altre informazioni sull'osservabilità in API Management di Azure
Nell'istanza di Gestione API:
Per visualizzare i log delle risorse e le metriche per Gestione API, configurare le impostazioni di diagnostica per raccogliere i log delle risorse e inviarli a un'area di lavoro Log Analytics.
Per visualizzare dati dettagliati sulle richieste al gateway di API Management, integrare l'istanza di API Management con Application Insights.
Nota
Per visualizzare i dati in un singolo dashboard, configurare l'area di lavoro Log Analytics per le impostazioni di diagnostica e l'istanza di Application Insights nello stesso gruppo di risorse dell'istanza di API Management.
Nell'area di lavoro Grafana gestita:
- Per creare un'istanza e un'area di lavoro Grafana con gestione, vedere l'avvio rapido per il portale o l'interfaccia della riga di comando di Azure.
- L'istanza di Grafana con gestione deve trovarsi nella stessa sottoscrizione dell'istanza di API Management.
- Al momento della creazione, all'area di lavoro Grafana viene assegnata automaticamente un'identità gestita di Microsoft Entra, a cui viene assegnato il ruolo Lettore di monitoraggio nella sottoscrizione. Questo approccio consente di accedere immediatamente a Monitoraggio di Azure dalla nuova area di lavoro Grafana senza dover impostare manualmente le autorizzazioni. Altre informazioni sulla configurazione delle origini dati per Grafana con gestione.
Importare prima di tutto il dashboard di API Management nell'area di lavoro di Grafana con gestione.
Per importare il dashboard:
- Andare all'area di lavoro Grafana con gestione Azure. Nella pagina Panoramica dell'istanza di Grafana con gestione del portale selezionare il collegamento Endpoint.
- Nell'area di lavoro Grafana con gestione andare a Dashboard>Sfoglia>importa.
- Nella pagina Importa, in Importa tramite grafana.comimmettere 16604 e selezionare Carica.
- Selezionare un'origine dati di Monitoraggio di Azure, esaminare o aggiornare le altre opzioni e selezionare Importa.
Per usare il dashboard Gestione API:
- Nell'area di lavoro Grafana con gestione andare a Dashboard>Esplora e selezionare il dashboard di API Management.
- Negli elenchi a discesa nella parte superiore effettuare selezioni per l'istanza di API Management. Se configurata, selezionare un'istanza di Application Insights e un'area di lavoro Log Analytics.
Esaminare le visualizzazioni predefinite nel dashboard, simile allo screenshot seguente:
Esportare i dati di Monitoraggio di Azure
È possibile esportare i dati da Monitoraggio di Azure in altri strumenti usando:
Metriche: usare l'API REST per le metriche per estrarre i dati delle metriche dal database delle metriche del Monitoraggio di Azure. Per altre informazioni, vedere Informazioni di riferimento sull'API REST del Monitoraggio di Azure.
Log: usare l'API REST o le librerie client associate.
Esportazione dei dati dell'area di lavoro Log Analytics.
Per iniziare a usare l'API REST di Monitoraggio di Azure, vedere Procedura dettagliata per l'API REST di monitoraggio di Azure.
Usare query Kusto per analizzare i dati di log
È possibile analizzare i dati dei log di Monitoraggio di Azure usando il linguaggio di query Kusto (KQL). Per altre informazioni, vedere Log di query in Monitoraggio di Azure.
Usare gli avvisi di Monitoraggio di Azure per notificare i problemi
Gli avvisi di Monitoraggio di Azure consentono di identificare e risolvere i problemi nel sistema e inviare notifiche proattive quando vengono rilevate condizioni specifiche nei dati di monitoraggio prima che i clienti li notino. È possibile creare avvisi su qualsiasi metrica o fonte di dati di log nella piattaforma di dati di Monitoraggio di Azure. Esistono diversi tipi di avvisi di Monitoraggio di Azure a seconda dei servizi monitorati e dei dati di monitoraggio raccolti. Vedere Scelta del tipo di regola di avviso corretto.
Per informazioni su come configurare una regola di avviso in Azure Gestione API, vedere Configurare una regola di avviso.
Per esempi di avvisi comuni per le risorse di Azure, vedere Query di avviso di log di esempio.
Implementazione di avvisi su larga scala
Per alcuni servizi, è possibile effettuare un monitoraggio su larga scala applicando la stessa regola di avviso delle metriche a più risorse dello stesso tipo presenti nella stessa area di Azure. Gli avvisi di base di Monitoraggio di Azure (AMBA) offrono un metodo semi-automatizzato per implementare importanti avvisi, dashboard e linee guida per le metriche della piattaforma su larga scala.
Ottenere raccomandazioni personalizzate con Azure Advisor
Per alcuni servizi, se si verificano condizioni critiche o modifiche imminenti durante le operazioni sulle risorse, viene visualizzato un avviso nella pagina Panoramica del servizio nel portale. È possibile trovare altre informazioni e correzioni consigliate per l'avviso in Consigli di Advisor in Monitoraggio nel menu a sinistra. Durante il normale funzionamento non viene visualizzato nessun consiglio di Advisor.
Per altre informazioni su Azure Advisor, vedere Informazioni generali su Azure Advisor.