Monitorare le API pubblicateMonitor published APIs

Monitoraggio di Azure è un servizio di Azure che offre un'unica origine per il monitoraggio di tutte le risorse di Azure.Azure Monitor is an Azure service that provides a single source for monitoring all your Azure resources. Con Monitoraggio di Azure è possibile visualizzare, eseguire query, indirizzare, archiviare ed effettuare operazioni sulle metriche e sui log provenienti dalle risorse di Azure, tra cui Gestione API.With Azure Monitor, you can visualize, query, route, archive, and take actions on the metrics and logs coming from Azure resources such as API Management.

In questa esercitazione si apprenderà come:In this tutorial, you learn how to:

  • Visualizzare log di attivitàView activity logs
  • Visualizzare i log di diagnosticaView diagnostic logs
  • Visualizzare le metriche dell'APIView metrics of your API
  • Configurare una regola di avviso quando l'API riceve delle chiamate non autorizzateSet up an alert rule when your API gets unauthorized calls

Il video seguente illustra come monitorare Gestione API usando Monitoraggio di Azure.The following video shows how to monitor API Management using Azure Monitor.

prerequisitiPrerequisites

Per passare all'istanza di Gestione API, seguire questa procedura:To navigate to your APIM instance, follow these steps:

  1. Accedere al portale di Azure.Sign in to the Azure portal.
  2. SelezionareSelect freccia..
  3. Nella casella di ricerca digitare "api".Type "api" in the search box.
  4. Fare clic su Servizi Gestione API.Click API Management services.

    Esplorare

  5. Selezionare l'istanza del servizio Gestione API.Select your APIM service instance.

Suggerimento

Aggiungere Gestione API ai Preferiti del portale di Azure facendo clic sulla stella.Add API Management (APIM) to your favorites in the Azure portal by clicking the star.
L'icona Gestione API viene aggiunta al menu disponibile nella parte sinistra del portale.This adds the APIM icon to the menu on the left of the portal. Per visualizzare tutti i servizi di Gestione API, fare clic sull'icona (icona Gestione API).To see all your APIM services, click the icon (APIM icon).

Visualizzare log di attivitàView activity Logs

I log attività offrono informazioni dettagliate sulle operazioni eseguite nei servizi Gestione API.Activity logs provide insight into the operations that were performed on your API Management services. L'uso del log attività consente di acquisire informazioni dettagliate su qualsiasi operazione di scrittura (PUT, POST, DELETE) eseguita sui servizi Gestione API.Using activity logs, you can determine the "what, who, and when" for any write operations (PUT, POST, DELETE) taken on your API Management services.

Nota

I log attività non includono le operazioni di lettura (GET) né le operazioni eseguite nel portale di pubblicazione classico o usando le API di gestione originali.Activity logs do not include read (GET) operations or operations performed in the classic Publisher Portal or using the original Management APIs.

È possibile accedere ai log attività del servizio Gestione API o ai log di tutte le risorse di Azure in Monitoraggio di Azure.You can access activity logs in your API Management service, or access logs of all your Azure resources in Azure Monitor.

Per visualizzare i log di attività:To view activity logs:

  1. Selezionare l'istanza del servizio Gestione API.Select your APIM service instance.
  2. Fare clic su Log attività.Click Activity log.

Visualizzare i log di diagnosticaView diagnostic Logs

I log di diagnostica offrono informazioni dettagliate sulle operazioni e gli errori importanti per il controllo e per la risoluzione dei problemi.Diagnostic logs provide rich information about operations and errors that are important for auditing as well as troubleshooting purposes. I log di diagnostica differiscono dai log attività.Diagnostics logs differ from activity logs. I log attività offrono informazioni approfondite sulle operazioni eseguite nelle risorse di Azure.Activity logs provide insights into the operations that were performed on your Azure resources. I log di diagnostica forniscono informazioni approfondite sulle operazioni che la risorsa esegue automaticamente.Diagnostics logs provide insight into operations that your resource performed itself.

Per accedere ai log di diagnostica:To access diagnostic logs:

  1. Selezionare l'istanza del servizio Gestione API.Select your APIM service instance.
  2. Fare clic su Log di diagnostica.Click Diagnostic log.

Visualizzare le metriche delle APIView metrics of your APIs

Gestione API genera le metriche ogni minuto in modo da ottenere una visibilità quasi in tempo reale dello stato e dell'integrità delle API.API Management emits metrics every minute, giving you near real-time visibility into the state and health of your APIs. Di seguito è riportato un riepilogo delle metriche disponibili:Following is a summary of some of the available metrics:

  • Capacità (anteprima): consente di decidere se eseguire l'aggiornamento o il downgrade dei servizi di Gestione API.Capacity (preview): helps you make decisions about upgrading/downgrading your APIM services. La metrica viene emessa ogni minuto e riflette la capacità del gateway nel momento in cui viene eseguito il report.The metric is emitted per minute and reflects the gateway capacity at the time of reporting. La metrica ha un intervallo compreso tra 0 e 100 e viene calcolata in base alle risorse gateway, quali uso della CPU e della memoria.The metric ranges from 0-100 and is calculated based on gateway recourses such as CPU and memory utilization.
  • Totale richieste gateway: numero di richieste di API nel periodo.Total Gateway Requests: the number of API requests in the period.
  • Richieste gateway riuscite: numero di richieste di API che hanno ricevuto codici di risposta HTTP corretta, tra cui 304, 307 e qualsiasi valore inferiore a 301, ad esempio, 200.Successful Gateway Requests: the number of API requests that received successful HTTP response codes including 304, 307 and anything smaller than 301 (for example, 200).
  • Richieste gateway non riuscite: numero di richieste di API che hanno ricevuto codici di risposta HTTP errata, tra cui 400 e qualsiasi valore superiore a 500.Failed Gateway Requests: the number of API requests that received erroneous HTTP response codes including 400 and anything larger than 500.
  • Richieste gateway non autorizzate: numero di richieste di API che hanno ricevuto codici di risposta HTTP tra cui 401, 403 e 429.Unauthorized Gateway Requests: the number of API requests that received HTTP response codes including 401, 403, and 429.
  • Altre richieste gateway: numero di richieste di API che hanno ricevuto codici di risposta HTTP che non appartengono a una delle categorie precedenti, ad esempio, 418.Other Gateway Requests: the number of API requests that received HTTP response codes that do not belong to any of the preceding categories (for example, 418).

Per accedere alle metriche:To access metrics:

  1. Selezionare Metriche dal menu nella parte inferiore della pagina.Select Metrics from the menu near the bottom of the page.
  2. Dall'elenco a discesa selezionare le metriche desiderate. È possibile aggiungere più metriche.From the drop-down, select metrics you are interested in (you can add multiple metrics).

    Selezionare ad esempio Totale richieste gateway e Richieste gateway non riuscite dall'elenco delle metriche disponibili.For example, select Total Gateway Requests and Failed Gateway Requests from the list of available metrics.

  3. Il grafico mostra il numero totale di chiamate API.The chart shows the total number of API calls. Viene indicato anche il numero di chiamate API non riuscite.It also shows the number of API calls that failed.

Configurare una regola di avviso per le richieste non autorizzateSet up an alert rule for unauthorized request

È possibile configurare un avviso basato sulle metriche e sui log attività.You can configure to receive alerts based on metrics and activity logs. Monitoraggio di Azure consente di configurare un avviso in modo che, se attivato, esegua queste operazioni:Azure Monitor allows you to configure an alert to do the following when it triggers:

  • Inviare una notifica via posta elettronicaSend an email notification
  • Chiamare un webhookCall a webhook
  • Richiamare un'app per la logica di AzureInvoke an Azure Logic App

Per configurare gli avvisi:To configure alerts:

  1. Selezionare Regole di avviso nella barra dei menu nella parte inferiore della pagina.Select Alert rules from the menu bar near the bottom of the page.
  2. Selezionare Aggiungi avviso per la metrica.Select Add metric alert.
  3. Immettere un nome per questo avviso.Enter a Name for this alert.
  4. Selezionare Richieste del gateway non autorizzate come metrica da monitorare.Select Unauthorized Gateway Requests as the metric to monitor.
  5. Selezionare Invia messaggio di posta elettronica a proprietari, collaboratori e lettori.Select Email owners, contributors, and readers.
  6. Premere OK.Press OK.
  7. Provare a chiamare l'API Conferenza senza una chiave API.Try to call our Conference API without an API key. In quanto proprietario del servizio Gestione API, l'utente riceverà un avviso di posta elettronica.As the owner of this API Management service, you receive an email alert.

    Suggerimento

    Quando viene attivata, la regola di avviso può anche chiamare un webhook o un'app per la logica di Azure.The alert rule can also call a Web Hook or an Azure Logic App when it is triggered.

    set-up-alert

Passaggi successiviNext steps

Questa esercitazione illustra come:In this tutorial, you learned how to:

  • Visualizzare log di attivitàView activity logs
  • Visualizzare i log di diagnosticaView diagnostic logs
  • Visualizzare le metriche dell'APIView metrics of your API
  • Configurare una regola di avviso quando l'API riceve delle chiamate non autorizzateSet up an alert rule when your API gets unauthorized calls

Passare all'esercitazione successiva:Advance to the next tutorial: