Как посмотреть журналы с помощью API

Вы просматриваете документацию по Apigee Edge.
Перейдите к документации по Apigee X. Информация

Скачайте журналы API Monitoring, чтобы посмотреть необработанные данные, на основе которых рассчитываются показатели, отображаемые на страницах статистики API Monitoring. Вы можете скачать журналы за определенный период времени, для определенных прокси-серверов, кодов статуса и многих других переменных.

Примечание. По умолчанию вызовы Logs API возвращают только результаты с кодами статуса 4xx и 5xx, но не с кодом 2xx. Это сделано для того, чтобы ограничить количество результатов, поскольку большинство из них имеют код статуса 2xx. Чтобы получить результаты с кодом статуса 2xx, добавьте в запрос status=2xx. Пример: https://apimonitoring.enterprise.apigee.com/logs?status=2xx.

В разделах ниже описано, как управлять журналами с помощью API:

Подробнее о Logs API…

Информацию о параметрах cURL, используемых в этих примерах, можно найти в разделе Как использовать cURL.

Как скачать журналы для организации и среды

Чтобы скачать журналы для определенной организации и среды, используйте Logs API:

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

Вам необходимо передать название организации и среды с помощью параметров запроса org и env.

По умолчанию API возвращает 10 последних записей журнала за предыдущий час. Пример:

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

Установите для параметра $ACCESS_TOKEN токен доступа OAuth 2.0, как описано в разделе Получение токена доступа OAuth 2.0.

Ответ представляет собой массив записей журнала в следующем формате:

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

Чтобы задать временной диапазон в формате ISO, используйте параметры запроса from и to. Формат даты может быть следующим:

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

Пример:

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"

В API много необязательных параметров запроса. Например, чтобы посмотреть журналы для прокси-сервера с названием myAPI, который генерирует ответы 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"

Чтобы получить более 10 записей журнала, задайте параметр запроса limit. Вы можете задать максимальное значение 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"

Другие варианты приведены в Logs API.

Как получить список прокси-серверов, связанных с виртуальным хостом и базовым путем

Виртуальный хост на маршрутизаторе Edge позволяет указать доменное имя, протокол, например HTTP/HTTPS, и номер порта. Например, вы определяете виртуальный хост на маршрутизаторе Edge с указанными ниже настройками.

  • host alias = apis.acme.com
  • port = 443
  • TLS включен

Исходя из этих настроек, запрос к прокси API, связанному с этим виртуальным хостом, будет иметь следующий вид:

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

Где:

  • proxy-base-path определяется при создании прокси-сервера API и является уникальным для каждого прокси-сервера API.
  • resource-path – это путь к ресурсу, доступному через прокси-сервер API.

Подробнее о виртуальных хостах…

Чтобы скачать список прокси API, связанных с определенным виртуальным хостом и базовым путем, отправьте GET-запрос к следующему ресурсу Logs API:

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

Вам необходимо передать название организации и среды, используя параметры запроса org и env, а также URI, связанный с виртуальным хостом и базовым путем.

Например, следующий вызов API возвращает прокси-серверы, связанные с виртуальным хостом http://apis.acme.com и базовым путем /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"

Установите для параметра $ACCESS_TOKEN токен доступа OAuth 2.0, как описано в разделе Получение токена доступа OAuth 2.0.

Другие варианты приведены в Logs API.