Logs mit der API ansehen

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

Laden Sie die API-Überwachungsprotokolle herunter, um die Rohdaten anzuzeigen, die zur Berechnung der in den API-Überwachungsdashboards angezeigten Kennzahlen verwendet werden. Sie können Protokolle für benutzerdefinierte Zeitbereiche, bestimmte Proxys, bestimmte Statuscodes und für viele andere Variablen herunterladen.

Hinweis:Standardmäßig geben Aufrufe der Logs API nur Ergebnisse mit den Statuscodes 4xx und 5xx zurück, aber keine mit dem Code 2xx. So wird die Anzahl der Ergebnisse begrenzt, da die meisten Ergebnisse den Statuscode 2xx haben. Wenn Sie Ergebnisse mit dem Statuscode 2xx erhalten möchten, fügen Sie der Anfrage status=2xx hinzu. Beispiel: https://apimonitoring.enterprise.apigee.com/logs?status=2xx.

In den folgenden Abschnitten wird beschrieben, wie Protokolle mithilfe der API verwaltet werden:

Weitere Informationen zur Protokoll-API finden Sie unter Protokoll-API.

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

Protokolle für eine Organisation und Umgebung herunterladen

Laden Sie die Protokolle für eine bestimmte Organisation und Umgebung mithilfe der Protokoll-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 zehn letzten 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 ist ein Array von Protokolleinträgen in folgender 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. Das Datumsformat kann Folgendes sein:

  • 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 Protokolle für einen Proxy mit dem Namen 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 Sie mehr als 10 Logeinträge zurückgeben möchten, legen Sie den Abfrageparameter limit fest. Sie können einen maximalen Wert 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 Protokoll-API.

Listen Sie die Proxys auf, die einem virtuellen Host und einem Basispfad zugeordnet sind

Mit einem virtuellen Host auf einem Edge Router können Sie einen Domänennamen, 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 Anforderung an einen diesem virtuellen Host zugeordneten API-Proxy das folgende Formular:

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.
  • 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 einem bestimmten virtuellen Host und Basispfad zugeordnet sind, indem Sie eine GET-Anfrage an die folgende Ressource der Protokoll-API ausgeben:

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

Sie müssen den Namen der Organisation und der Umgebung über die Abfrageparameter org und env sowie den mit dem virtuellen Host und dem Basispfad verknüpften URI übergeben.

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