Logs mit der API ansehen

Sie sehen die Dokumentation zu Apigee Edge.
Zur Apigee X-Dokumentation weitere Informationen

Laden Sie die API-Monitoringlogs herunter, um die Rohdaten anzusehen, die zur Berechnung der in den API-Monitoring-Dashboards verwendeten Messwerte verwendet werden. Sie können Protokolle für benutzerdefinierte Zeitbereiche, bestimmte Proxys, bestimmte Statuscodes und für viele andere Variablen herunterladen.

Hinweis: Standardmäßig werden bei Aufrufen der Logs API nur Ergebnisse mit den Statuscodes 4xx und 5xx zurückgegeben, aber nicht mit dem Code 2xx. Dies geschieht, um die Anzahl der Ergebnisse zu begrenzen, da die meisten Ergebnisse den Statuscode 2xx haben. Fügen Sie der Anfrage status=2xx hinzu, um Ergebnisse mit dem Statuscode 2xx zu erhalten. Beispiel: https://apimonitoring.enterprise.apigee.com/logs?status=2xx.

In den folgenden Abschnitten wird beschrieben, wie Sie Logs mithilfe der API verwalten:

Weitere Informationen zur Logs API finden Sie unter Logs API.

Informationen zu den in diesen Beispielen verwendeten cURL-Optionen finden Sie unter cURL verwenden.

Logs für eine Organisation und Umgebung herunterladen

Laden Sie die Logs für eine bestimmte Organisation und Umgebung mithilfe der Logs API herunter:

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

Sie müssen den Namen der Organisation und der Umgebung mithilfe der Abfrageparameter org und env übergeben.

Standardmäßig gibt die API die letzten zehn Logeinträge für die vorherige Stunde zurück. Beispiel:

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

Stellen Sie $ACCESS_TOKEN auf Ihr OAuth 2.0-Zugriffstoken ein, wie unter OAuth 2.0-Zugriffstoken anfordern beschrieben.

Die Antwort besteht aus einem Array von Logeinträgen in der Form:

[   
  {
"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"
  },
  …
]

Verwenden Sie die Abfrageparameter from und to, um einen ISO-formatierten Zeitbereich anzugeben. Folgende Datumsformate sind möglich:

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

Beispiel:

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"

Die API verfügt über viele optionale Abfrageparameter. So rufen Sie beispielsweise die Logs für einen Proxy namens myAPI auf, der HTTP-404-Antworten generiert:

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"

Wenn mehr als zehn Logeinträge zurückgegeben werden sollen, legen Sie den Abfrageparameter limit fest. Sie können den Maximalwert auf 1.000 festlegen:

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"

Weitere Optionen finden Sie in der Protokoll-API.

Listen Sie die Proxys auf, die mit einem virtuellen Host und Basispfad verknüpft sind

Mit einem virtuellen Host auf einem Edge Router können Sie einen Domainnamen, ein Protokoll wie HTTP/HTTPS und eine Portnummer angeben. Sie definieren beispielsweise einen virtuellen Host auf einem Edge-Router mit den folgenden Einstellungen:

  • Host-Alias = apis.acme.com
  • port = 443
  • TLS aktiviert

Basierend auf diesen Einstellungen verwendet eine Anfrage an einen API-Proxy, der mit diesem virtuellen Host verknüpft ist, das folgende Formular:

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

Wobei:

  • Proxy-Basispfad wird beim Erstellen eines API-Proxys definiert und ist für jeden API-Proxy eindeutig.
  • Ressourcenpfad ist der Pfad zu einer Ressource, auf die über den API-Proxy zugegriffen werden kann.

Weitere Informationen zu virtuellen Hosts finden Sie unter Informationen zu virtuellen Hosts.

Laden Sie die Liste der API-Proxys herunter, die mit einem bestimmten virtuellen Host und Basispfad verknüpft sind. Senden Sie dazu eine GET-Anfrage an die folgende Ressource der Logs API:

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

Sie müssen den Namen der Organisation und der Umgebung mithilfe der Abfrageparameter org und env sowie des URI, der dem virtuellen Host und dem Basispfad zugeordnet ist, übergeben.

Der folgende API-Aufruf gibt beispielsweise die Proxys zurück, die dem virtuellen Host http://apis.acme.com und mit dem Basispfad /v1/perf zugeordnet sind:

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"

Stellen Sie $ACCESS_TOKEN auf Ihr OAuth 2.0-Zugriffstoken ein, wie unter OAuth 2.0-Zugriffstoken anfordern beschrieben.

Weitere Optionen finden Sie in der Protokoll-API.