Visualizza i log utilizzando l'API

Stai visualizzando la documentazione di Apigee Edge.
Consulta la documentazione di Apigee X. info

Scarica i log di monitoraggio API per visualizzare i dati non elaborati utilizzati per calcolare le metriche visualizzate nelle dashboard di monitoraggio API. Puoi scaricare i log per intervalli di tempo personalizzati, proxy specifici, codici di stato specifici e per molte altre variabili.

Nota: per impostazione predefinita, le chiamate all'API Logs restituiscono solo i risultati con i codici di stato 4xx e 5xx, ma non con il codice 2xx. Questa operazione viene eseguita per limitare il numero di risultati, poiché la maggior parte dei risultati ha il codice di stato 2xx. Per ottenere risultati con il codice di stato 2xx, aggiungi status=2xx alla richiesta. Ad esempio: https://apimonitoring.enterprise.apigee.com/logs?status=2xx.

Le sezioni seguenti descrivono come gestire i log utilizzando l'API:

Per saperne di più sull'API Logs, consulta la documentazione relativa.

Per informazioni sulle opzioni cURL utilizzate in questi esempi, consulta Utilizzare cURL.

Scaricare i log per un'organizzazione e un ambiente

Scarica i log per un'organizzazione e un ambiente specifici utilizzando l'API Logs:

https://apimonitoring.enterprise.apigee.com/logs

Devi passare il nome dell'organizzazione e dell'ambiente utilizzando i parametri di query org e env.

Per impostazione predefinita, l'API restituisce le 10 voci di log più recenti per l'ora precedente. Ad esempio:

curl -X GET \
"https://apimonitoring.enterprise.apigee.com/logs?org=myorg&env=prod" \
-H "accept: application/json" \
-H "Authorization: Bearer $ACCESS_TOKEN"

Imposta $ACCESS_TOKEN sul token di accesso OAuth 2.0, come descritto in Ottenere un token di accesso OAuth 2.0.

La risposta è un array di voci di log nel formato:

[   
  {
"request":"GET /v1/o/myorg/z HTTP/1.1",
    "request_length":1349,
    "request_message_id":"rrt-0623eb157b650315c-c-ne-7785-16029140-1",
    "virtual_host":"api.enterprise.apigee.com",
    "response_size":144,
    "response_time":0.551,
    "response_status":"404",
    "timestamp":"2018-08-14T17:31:07Z",
    "fault_code":"messaging.adaptors.http.flow.ErrorResponseCode",
    "fault_flow":"-",
    "fault_policy":"null/null",
    "fault_proxy":
        "/organizations/myorg/environments/prod/apiproxies/myAPI/revisions/50",
    "fault_source":"target"
  },
  …
]

Utilizza i parametri di query from e to per specificare un intervallo di tempo in formato ISO. Il formato della data può essere:

  • yyyy-mm-ddThh:mm:ssZ
  • yyyy-mm-ddThh:mm:ss+00:00

Ad esempio:

curl -X GET \
"https://apimonitoring.enterprise.apigee.com/logs?org=myorg&env=prod&from=2018-08-13T14%3A04%3A00Z&to=2018-08-13T14%3A10%3A00Z" \
-H "accept: application/json" \
-H "Authorization: Bearer $ACCESS_TOKEN"

L'API ha molti parametri di query facoltativi. Ad esempio, per visualizzare i log di un proxy denominato myAPI che genera risposte HTTP 404:

curl -X GET \
"https://apimonitoring.enterprise.apigee.com/logs?org=myorg&env=prod&proxy=myAPI&status=404" \
-H "accept: application/json" \
-H "Authorization: Bearer $ACCESS_TOKEN"

Per restituire più di 10 voci di log, imposta il parametro di query limit. Puoi impostarlo su un valore massimo di 1000:

curl -X GET \
"https://apimonitoring.enterprise.apigee.com/logs?org=myorg&env=prod&proxy=myAPI&status=404&limit=200" \
-H "accept: application/json" \
-H "Authorization: Bearer $ACCESS_TOKEN"

Per altre opzioni, consulta l'API Logs.

Elencare i proxy associati a un host virtuale e a un percorso di base

Un host virtuale su un router Edge consente di specificare un nome di dominio, un protocollo come HTTP/HTTPS e un numero di porta. Ad esempio, definisci un host virtuale su un router Edge con le seguenti impostazioni:

  • Alias host = apis.acme.com
  • Porta = 443
  • TLS attivato

In base a queste impostazioni, una richiesta a un proxy API associato a questo host virtuale utilizza il modulo:

https://apis.acme.com/proxy-base-path/resource-path

Dove:

  • proxy-base-path viene definito quando crei un proxy API ed è univoco per ogni proxy API.
  • resource-path è il percorso di una risorsa accessibile tramite il proxy API.

Per saperne di più sugli host virtuali, consulta Informazioni sugli host virtuali.

Scarica l'elenco dei proxy API associati a un host virtuale e a un percorso di base specifici inviando una richiesta GET alla seguente risorsa dell'API Logs:

https://apimonitoring.enterprise.apigee.com/logs/apiproxies

Devi passare il nome dell'organizzazione e dell'ambiente utilizzando i parametri di query org e env, nonché l'URI associato all'host virtuale e al percorso di base.

Ad esempio, la seguente chiamata API restituisce i proxy associati all'host virtuale http://apis.acme.com e con un percorso di base /v1/perf:

curl -X GET \
"https://apimonitoring.enterprise.apigee.com/logs/apiproxies?org=myorg&env=prod&select=http://apis.acme.com/v1/perf" \
-H "accept: application/json" \
-H "Authorization: Bearer $ACCESS_TOKEN"

Imposta $ACCESS_TOKEN sul token di accesso OAuth 2.0, come descritto in Ottenere un token di accesso OAuth 2.0.

Per altre opzioni, consulta l'API Logs.