Возможность наблюдения в службе управления API Azure

ПРИМЕНЯЕТСЯ К: всем уровням управления API

Наблюдаемость — это возможность определить внутреннее состояние системы на основе данных, которые она создает, и возможность изучить эти данные, чтобы ответить на вопросы о том, что случилось и почему.

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

Обзор

Управление API Azure позволяет выбрать использование управляемого шлюза или локального шлюза, который развертывается либо автоматически, либо с использованием расширения Azure Arc.

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

Примечание.

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

Инструмент Полезно для Задержка данных4 Хранение Образец Тип данных Поддерживаемые модели развертывания
Трассировка запросов (инспектор API) Тестирование и отладка Мгновенные Последние 100 трассировок Включается по запросу Трассировка запросов Управляемое, самостоятельно размещённое, Azure Arc, рабочее пространство
Встроенная аналитика Создание отчетов и мониторинг Протокол собрания Срок службы 100% Отчеты и журналы Управляется
Метрики Azure Monitor Создание отчетов и мониторинг Протокол собрания 90 дня (необходимо обновление для продления) 100% Метрики Управляемый, самостоятельный хостинг2, Azure Arc
Журналы Azure Monitor Отчеты, мониторинг и отладка Протокол собрания 31 день/5 ГБ (необходимо обновление для продления) 100 % (можно настроить) Логи Управляемый1, самостоятельно размещённый3, Azure Arc3
приложение Azure Insights Отчеты, мониторинг и отладка секунды 90 дней/5 ГБ (необходимо обновление для продления) Настраиваемый Журналы, метрики Управляемое1, локальное1, Azure Arc1, рабочая область1
Ведение журналов через Event Hubs Azure Пользовательские сценарии секунды Управляет пользователь Настраиваемый Настраиваемый Управляемый1, Самостоятельный1, Azure Arc1
OpenTelemetry Наблюдение Протокол собрания Управляет пользователь 100% Метрики Локальный2

1 Необязательно, в зависимости от конфигурации функции в службе управления API Azure.
2 Необязательно, в зависимости от конфигурации шлюза.
3 Локальный шлюз в настоящее время не отправляет журналы диагностики в Azure Monitor. Однако можно настроить и сохранить журналы локально, где развернут локальный шлюз. Дополнительные сведения см. в разделе Настройка локальных метрик и журналов для самостоятельно размещаемого шлюза.
4 За исключением трассировки запросов, все ведение журнала в службе управления API выполняется асинхронно.

Лучшие практики

Следующие методики могут повысить наблюдаемость API.

  • Детализированный мониторинг: включите метрики для каждого метода для получения подробных сведений о времени отклика и скорости ошибок.
  • Мониторинг хвостовой задержки: настройте оповещения о хвостовой задержке для каждого метода (например, 90-й, 95-й или 99-й процентиль), так как средняя задержка может вводить в заблуждение. Чтобы реализовать эту функцию, используйте язык запросов Kusto (KQL) для пересылки журналов в рабочую область Log Analytics.
  • Проактивные оповещения: настройте оповещения для каждого метода по уровню ошибок и низкой доле успешных запросов; используйте показатели, а не абсолютные количества, чтобы обеспечить точность.
  • Распределенная трассировка: включите трассировку для выявления узких мест в производительности и устранения проблем.
  • Маркировка ресурсов тегами: назначайте теги API для точного отслеживания и распределения затрат.

Связанный контент

  • Last updated on