Logs mithilfe der API ansehen

Sie sehen sich die Apigee Edge-Dokumentation an.
Sehen Sie sich die Apigee X-Dokumentation an.

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

Hinweis: Standardmäßig werden beim Aufrufen der Logs API nur Ergebnisse mit den Statuscodes 4xx und 5xx, aber nicht mit dem Code 2xx zurückgegeben. Dadurch wird die Anzahl der Ergebnisse begrenzt, 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 mit 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 10 Logeinträge der vorherigen 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 ist ein Array von Logeinträgen im folgenden Format:

[   
  {
"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 Zeitraum im ISO-Format anzugeben. Das Datumsformat kann entweder:

  • 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 enthält viele optionale Suchparameter. So sehen Sie sich beispielsweise die Protokolle für einen Proxy namens myAPI an, 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 10 Logeinträge zurückgegeben werden sollen, legen Sie den limit-Abfrageparameter fest. Sie können einen Maximalwert von 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 Logs API.

Proxys auflisten, 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

Auf Basis dieser Einstellungen wird eine Anfrage an einen API-Proxy gesendet, der mit diesem virtuellen Host verknüpft ist:

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

Wobei:

  • proxy-base-path wird beim Erstellen eines API-Proxys definiert und ist für jeden API-Proxy eindeutig.
  • resource-path 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 einem bestimmten virtuellen Host und Basispfad zugeordnet 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 mit den Abfrageparametern org und env sowie dem URI senden, der dem virtuellen Host und dem Basispfad zugeordnet ist.

Der folgende API-Aufruf gibt beispielsweise die Proxys zurück, die dem virtuellen Host http://apis.acme.com und 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 Logs API.