Получение аналитики в службе управления API Azure

ОБЛАСТЬ ПРИМЕНЕНИЯ: Разработчик | Базовый | Базовая версия 2 | Стандартный | Standard v2 | Премиум

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

Снимок экрана: аналитика API на портале.

Сведения об аналитике API

  • Управление API предоставляет аналитику с помощьюПанель мониторинга на основе Azure Monitor. Панель мониторинга объединяет данные в рабочей области Azure Log Analytics.

  • На классических уровнях служб Управление API экземпляр Управление API также включает устаревшую встроенную аналитику в портал Azure, а данные аналитики можно получить с помощью REST API Управление API. Эквивалентные данные отображаются на панели мониторинга на основе Azure Monitor и встроенной аналитике.

Внимание

  • Панель мониторинга на основе Azure Monitor — это рекомендуемый способ доступа к данным аналитики.
  • Устаревшая встроенная аналитика недоступна на уровнях версии 2.

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

  • Время
  • Географический регион
  • Программные интерфейсы
  • Операции API
  • Продукты
  • Подписки
  • Пользователи
  • Запросы

Примечание.

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

Панель мониторинга на основе Azure Monitor

Чтобы использовать панель мониторинга на основе Azure Monitor, необходимо настроить рабочую область Log Analytics в качестве источника данных для журналов шлюза Управление API.

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

  1. Перейдите к экземпляру Управления API на портале Azure.
  2. В меню слева в разделе "Мониторинг" выберите "Параметры диагностики" и "Добавить параметр диагностики>".
  3. Введите описательное имя параметра диагностики.
  4. В журналах выберите журналы, связанные с шлюзом ApiManagement.
  5. В сведениях о назначении выберите "Отправить в Log Analytics" и выберите рабочую область Log Analytics в той же или другой подписке. Если вам нужно создать рабочую область, см. статью "Создание рабочей области Log Analytics".
  6. Примите значения по умолчанию для других параметров или настройте их по мере необходимости. Выберите Сохранить.

Доступ к панели мониторинга

После настройки рабочей области Log Analytics откройте панель мониторинга на основе Azure Monitor для анализа использования и производительности API.

  1. Перейдите к экземпляру Управления API на портале Azure.
  2. В меню слева в разделе "Мониторинг" выберите Аналитика. Откроется панель мониторинга аналитики.
  3. Выберите диапазон времени для данных.
  4. Выберите категорию отчета для данных аналитики, например временная шкала, география" и т. д.

Устаревшая встроенная аналитика

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

Встроенная аналитика — портал

Чтобы получить доступ к встроенной аналитике в портал Azure, выполните следующие действия.

  1. Перейдите к экземпляру Управления API на портале Azure.
  2. В меню слева в разделе Мониторинг выберите Аналитика.
  3. Выберите диапазон времени для данных или введите настраиваемый диапазон времени.
  4. Выберите категорию отчета для данных аналитики, например временная шкала, география" и т. д.
  5. При необходимости можно отфильтровать отчет по одной или нескольким дополнительным категориям.

Аналитика — REST API

Используйте операции с отчетами в REST API управления API для получения и фильтрации данных аналитики для экземпляра службы управления API.

Доступные операции возвращают записи отчетов по API, географии, операциям API, продукту, запросу, подписке, времени или пользователю.