Создание специальных отчетов

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

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

Создание специального отчета с учетом контекста

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

Параметры и показатели по умолчанию

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

Как изменить специальный отчет

Как упоминалось в предыдущем разделе, в специальных отчетах предварительно настроен стандартный набор параметров и показателей для мониторинга API. После создания отчета вы можете добавить или удалить в нем показатели и параметры. Например, вы можете ограничить область поиска определенным токеном доступа, приложением разработчика, прокси-сервером API или идентификатором запроса.

В следующем специальном отчете вы добавляете предопределенный параметр Gateway Flow ID, который Gateway Flow ID содержит уникальный UUID каждого запроса к API, отправленного в Edge. Обратите внимание, что в отчете уже используется параметр Request URI:

В примере ниже в специальный отчет добавляется параметр Client ID. Параметр Client ID содержит идентификатор клиента (ключ API) разработчика, который выполняет вызов API. Ключ может быть передан в запросе как ключ API или включен в токен OAuth:

Специальный отчет содержит информацию обо всех значениях Client ID. В следующем примере добавляется фильтр, чтобы можно было создать специальный отчет для определенного Client ID:

Подробнее о стандартных параметрах и показателях, которые можно добавить в отчет…

В следующем примере в специальный отчет, в котором собираются показатели и параметры по умолчанию, добавляется фильтр для policies.ratelimit.QuotaViolationкода ошибки и кодов статуса 5xx:

Подробнее о том, как управлять специальными отчетами…

Пример: как использовать специальные отчеты для диагностики проблем с развертыванием

Прикрепите правило StatisticsCollector к прокси API, чтобы собирать собственные аналитические данные, например идентификаторы пользователей или товаров, цены, действия REST, целевые версии, целевые URL и длину сообщений. Данные могут поступать из переменных потока, заданных Apigee, заголовков запросов, параметров запросов или пользовательских переменных, которые вы определяете.

Например, запросы к прокси-серверу API включают заголовки с идентификатором продукта, идентификатором пользователя и версией целевого сервера. Запрос может выглядеть следующим образом:

curl -H "prodid:123456" -H "userid:98765" -H "targetversion:beta" http://myapi.com/myapi

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

Чтобы создать специальный отчет для этих заголовков:

1. Добавьте в API правило StatisticsCollector, чтобы получать значения специальных заголовков:

   <StatisticsCollector name="publishPurchaseDetails">
     <Statistics>
       <Statistic name="prodid" ref="request.header.prodid" type="integer">0</Statistic>
       <Statistic name="userid" ref="request.header.userid" type="integer">0</Statistic>
       <Statistic name="targetversion" ref="request.header.targetversion" type="string">alpha</Statistic>
     </Statistics>
   </StatisticsCollector>

2. Разверните прокси-сервер и подождите, пока он станет доступен.

3. Чтобы посмотреть проблемы с API, в интерфейсе Edge нажмите Analyze (Анализ) > API Monitoring (Мониторинг API) > Recent (Последние). Обратите внимание, что для прокси-сервера myapi возникают ошибки 4xx и 5xx:

   

4. Выберите строку прокси-сервера myapi, чтобы посмотреть подробную информацию на панели справа на странице "Недавнее".

5. На панели "Недавние" справа выберите > Посмотреть на панели "Исследование", чтобы перейти на панель "Исследование".

   

6. Отфильтруйте данные на панели "Исследование" по прокси-серверу myapi и посмотрите код статуса на диаграмме вверху. Обратите внимание, что вы получаете ошибки 403 и 501:

   

7. В интерфейсе Edge выберите Analytics > Custom Reports > Reports (Аналитика > Специальные отчеты > Отчеты), чтобы создать специальный отчет, в котором значения этих специальных показателей будут представлены как параметр.

8. Нажмите + Специальный отчет, чтобы создать специальный отчет с названием myapi_errors.

9. Выберите Ошибки прокси-сервера в качестве показателя и задайте для Агрегатной функции значение Сумма. При необходимости вы можете добавить другие показатели.

10. Выберите стандартный параметр Код статуса ответа, а затем добавьте три специальных параметра prodid, targetersion и userid в раздел "Параметры":

    

11. Настройте фильтр так, чтобы он включал только данные для прокси-сервера API myapi (apiproxy eq 'myapi'):

    

12. Сохраните отчет.

13. Создайте отчет за последние 24 часа. При первом открытии отчета вы увидите диаграмму ошибок HTTP 403 и 501:

    

14. В разделе Сводка нажмите 403 или 510, чтобы узнать, какой продукт вызывает ошибки. Например, вы выбрали 403:

    

15. Нажмите на идентификатор товара в разделе Сводка, чтобы посмотреть ошибки по целевой версии (альфа или бета):

    

16. Нажмите на целевую версию в разделе Сводка, чтобы посмотреть ошибки по пользователям: