Monitorare Gestione API con Monitoraggio di AzureMonitor API Management with Azure Monitor

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.

Il video seguente illustra come monitorare Gestione API usando Monitoraggio di Azure.The following video shows how to monitor API Management using Azure Monitor. Per altre informazioni su Monitoraggio di Azure, vedere l'introduzione a Monitoraggio di Azure.For more information about Azure Monitor, see [Get Started with Azure Monitor].

MetricaMetrics

Gestione API attualmente genera cinque metriche e si prevede di aggiungerne altre in futuro.API Management currently emits five metrics and we plan to add more in the future. Le metriche vengono generate ogni minuto in modo da ottenere una visibilità quasi in tempo reale dello stato e dell'integrità delle API.These metrics are emitted every minute, giving you near real-time visibility into the state and health of your APIs. Di seguito è riportato un riepilogo delle metriche:Following is a summary of the metrics:

  • 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).

È possibile accedere alle metriche del servizio Gestione API o alle metriche di tutte le risorse di Azure in Monitoraggio di Azure.You can access metrics in your API Management service, or access metrics of all your Azure resources in Azure Monitor. Per visualizzare le metriche del servizio Gestione API:To view metrics in your API Management service:

  1. Aprire il Portale di Azure.Open the Azure portal.
  2. Accedere al servizio Gestione API.Go to your API Management service.
  3. Fare clic su Metrica.Click Metrics.

Pannello delle metriche

Per altre informazioni sull'uso delle metriche, vedere Panoramica delle metriche.For more information about how to use Metrics, see [Overview of Metrics].

Log attività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. In precedenza erano noti come "log di controllo" o "log operativi".It was previously known as "audit logs" or "operational logs". 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 attività del servizio Gestione API:To view activity logs in your API Management service:

  1. Aprire il Portale di Azure.Open the Azure portal.
  2. Accedere al servizio Gestione API.Go to your API Management service.
  3. Fare clic su Log attività.Click Activity log.

Pannello dei log attività

Per altre informazioni sull'uso dei log attività, vedere Panoramica del log attività di Azure.For more information about how to use Metrics, see [Overview of Activity Logs].

AvvisiAlerts

È 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

È possibile configurare regole per gli avvisi nel servizio Gestione API o in Monitoraggio di Azure.You can configure alert rules in your API Management service, or in Azure Monitor. Per configurarle in Gestione API:To configure them in API Management:

  1. Aprire il Portale di Azure.Open the Azure portal.
  2. Accedere al servizio Gestione API.Go to your API Management service.
  3. Fare clic su Regole di avviso.Click Alert rules.

Pannello Regole di avviso

Per altre informazioni sull'uso degli avvisi, vedere Panoramica degli avvisi.For more information about using Alerts, see [Overview of Alerts].

Log di diagnosticaDiagnostic 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.

Attualmente Gestione API offre ogni ora log di diagnostica in batch sulla singola richiesta API con ogni voce con la struttura seguente:API Management currently provides diagnostics logs (batched hourly) about individual API request with each entry having the following structure:

{
    "Tenant": "",
      "DeploymentName": "",
      "time": "",
      "resourceId": "",
      "category": "GatewayLogs",
      "operationName": "Microsoft.ApiManagement/GatewayLogs",
      "durationMs": ,
      "Level": ,
      "properties": "{
          "ApiId": "",
          "OperationId": "",
          "ProductId": "",
          "SubscriptionId": "",
          "Method": "",
          "Url": "",
          "RequestSize": ,
          "ServiceTime": "",
          "BackendMethod": "",
          "BackendUrl": "",
          "BackendResponseCode": ,
          "ResponseCode": ,
          "ResponseSize": ,
          "Cache": "",
          "UserId"
      }"
 }

È possibile accedere ai log di diagnostica del servizio Gestione API o ai log di tutte le risorse di Azure in Monitoraggio di Azure.You can access diagnostic logs in your API Management service, or access logs of all your Azure resources in Azure Monitor. Per visualizzare i log di diagnostica del servizio Gestione API:To view diagnostic logs in your API Management service:

  1. Aprire il Portale di Azure.Open the Azure portal.
  2. Accedere al servizio Gestione API.Go to your API Management service.
  3. Fare clic su Log di diagnostica.Click Diagnostic log.

Pannello Log di diagnostica

Per altre informazioni sull'uso dei log di diagnostica, vedere Raccogliere e usare i dati di diagnostica dalle risorse di Azure.For more information about how to use Metrics, see [Overview of Diagnostic Logs].

Passaggio successivoNext Step