Руководство по Мониторинг опубликованных API-интерфейсов

  • Статья

ОБЛАСТЬ ПРИМЕНЕНИЯ: все уровни Управление API

С помощью Azure Monitor можно визуализировать, запрашивать, маршрутизировать, архивировать метрики или журналы, полученные от службы "Управление API Azure", а также реагировать на них.

В этом руководстве описано следующее:

  • просмотр метрик API;
  • настройка правила оповещения;
  • Просмотр журналов действий
  • включение и просмотр журналов ресурсов.

Примечание.

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

Необходимые компоненты

Просмотр метрик API

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

  • Емкость — помогает принимать решения об обновлении и понижении Управление API служб. Метрика создается в минуту и отражает предполагаемый объем шлюза во время создания отчетов. Значение метрики колеблется в диапазоне от 0 до 100. Оно вычисляется на основе ресурсов шлюза, таких как загрузка центрального процессора и использование памяти.
  • Запросы. Помогает анализировать трафик API, проходящий через службы Управления API. Метрика отправляется каждую минуту и сообщает о количестве запросов к шлюзу с включением таких измерений. Фильтрация запросов по кодам ответа, расположению, имени узла и ошибкам.

Внимание

Следующие метрики устарели по состоянию на май 2019 года и будут прекращены в августе 2023 года: общее количество запросов шлюза, успешных запросов шлюза, несанкционированных запросов шлюза, неудачных запросов шлюза, других запросов шлюза. Используйте метрику Requests, которая имеет аналогичную функциональность.

Снимок экрана: метрики на странице обзора службы

Для доступа к метрике сделайте следующее:

  1. Перейдите к экземпляру Управления API на портале Azure. На вкладке "Обзор" на вкладке "Монитор " просмотрите ключевые метрики api.

  2. Чтобы подробно изучить метрики, выберите метрики в меню слева.

    Снимок экрана: элемент метрик в меню

  3. В раскрывающемся списке выберите метрики, которые вас интересуют. Например, Requests.

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

  5. Диаграмму можно отфильтровать с помощью измерений метрики запросов. Например, выберите " Добавить фильтр", выберите категорию кода ответа серверной части, введите 500 в качестве значения. Теперь на диаграмме показано количество запросов, завершившихся сбоем в серверной части API.

настройка правила оповещения;

Вы можете получать оповещения на основе метрик и журналов действий. В Azure Monitor настройте правило генерации оповещений для выполнения действия при активации. К общим действиям относятся:

  • Отправка уведомления по электронной почте
  • Вызов webhook.
  • Вызов приложения логики Azure.

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

  1. Перейдите к экземпляру Управления API на портале Azure.

  2. Выберите оповещения в меню слева.

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

  3. Выберите и создайте >правило генерации оповещений.

  4. На вкладке "Условие" в окне выбора сигнала:

    1. Выберите Метрики для параметра Тип сигнала.
    2. Выберите Запросы для параметра Имя сигнала.
    3. В логике генерации оповещений укажите пороговое значение, которое является числом вхождений, после которых должно быть активировано оповещение.
    4. В разделе Split by dimensions (Разделение по измерениям) в поле Имя измерения выберите Gateway Response Code Category (Категория кода отклика шлюза).
    5. В поле Значения измерения для таких ошибок клиента, как неавторизованные или недопустимые запросы, выберите значение 4xx. Если значение измерения не отображается, выберите "Добавить настраиваемое значение " и введите 4xx.
    6. В разделе "Когда необходимо оценить", примите параметры по умолчанию или выберите другие параметры, чтобы настроить частоту выполнения правила. Выберите Далее.

    Снимок экрана: настройка логики оповещений на портале.

  5. На вкладке "Действия" выберите или создайте одну или несколько групп действий, чтобы уведомить пользователей об оповещении и выполнить действие. Например, создайте новую группу действий, чтобы отправить уведомление по электронной почте admin@contoso.com. Подробные инструкции см. в статье "Создание групп действий и управление ими" в портал Azure.

    Снимок экрана: настройка уведомлений для новой группы действий на портале.

  6. На вкладке сведений о создании правила генерации оповещений введите имя и описание правила генерации оповещений и выберите уровень серьезности.

  7. При необходимости настройте оставшиеся параметры. Затем на вкладке "Просмотр и создание " нажмите кнопку "Создать".

  8. Теперь проверьте правило генерации оповещений, вызвав Conference API без ключа API. Например:

    curl GET https://apim-hello-world.azure-api.net/conference/speakers HTTP/1.1

    Триггеры оповещений основываются на периоде оценки и отправляют сообщение электронной почты admin@contoso.com.

    Кроме того, оповещения отображаются на странице Оповещения для экземпляра Управления API.

    Снимок экрана: оповещения на портале.

Журналы действий

Журналы действий позволяют подробно проанализировать операции, выполненные в службах управления API. С помощью журналов изменений можно ответить на вопросы "что? кто? когда?" о любой операции записи (PUT, POST, DELETE) в службах управления API.

Примечание.

Журналы действий не содержат операций чтения (GET) и операций, выполненных на портале Azure или с помощью исходных API управления.

Вы можете получить доступ к журналам действий в службе управления API или получить доступ к журналам всех ресурсов Azure в Azure Monitor.

Снимок экрана: журнал действий на портале.

Для просмотра журнала действий выполните следующие действия:

  1. Перейдите к экземпляру Управления API на портале Azure.

  2. Выберите Журнал действий.

    Снимок экрана: элемент журнала действий в меню

  3. Выберите требуемую область фильтрации и щелкните Применить.

Журналы ресурсов

Журналы ресурсов (журналы Azure Monitor) предоставляют широкие сведения о Управление API операциях и ошибках, важных для аудита и устранения неполадок. При включении с помощью параметра диагностики журналы собирают сведения о запросах API, полученных и обрабатываемых шлюзом Управление API.

Примечание.

Уровень потребления не поддерживает коллекцию журналов ресурсов.

Чтобы настроить журналы ресурсов, выполните приведенные ниже действия.

  1. Перейдите к экземпляру Управления API на портале Azure.

  2. Выберите Параметры диагностики.

    Снимок экрана: элемент параметров диагностики в меню

  3. Щелкните команду Добавить параметр диагностики.

  4. Выберите журналы или метрики для сбора.

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

    Совет

    Если выбрать рабочую область Log Analytics, можно сохранить данные в таблице ApiManagementGatewayLogs или сохранить их в общей таблице AzureDiagnostics. Мы рекомендуем использовать таблицу для конкретного ресурса, для назначений журналов, которые ее поддерживают. Подробнее

  5. После настройки сведений о назначении журнала или назначения нажмите кнопку "Сохранить".

Примечание.

Добавление объекта параметра диагностики может привести к сбою, если свойство MinApiVersion службы Управление API установлено для любой версии API выше 2022-09-01-preview.

Дополнительные сведения см. в статье Создание параметров диагностики для отправки журналов платформы и метрик в различные места назначения.

Просмотр диагностических данных в Azure Monitor

Если вы включите коллекцию журналов или метрик в рабочей области Log Analytics, данные могут отображаться в Azure Monitor через несколько минут.

Просмотр данных

  1. Перейдите к экземпляру Управления API на портале Azure.

  2. Выберите журналы в меню слева.

    Снимок экрана: элемент журналов в меню

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

    ApiManagementGatewayLogs
| where TimeGenerated > ago(1d)

    Снимок экрана: запрос таблицы ApiManagementGatewayLogs на портале.

Дополнительные сведения об использовании журналов ресурсов для Управления API см. в следующих статьях:

Изменение параметров ведения журнала API

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

Дополнительные сведения о параметрах ведения журнала см . в справочнике по параметрам ведения журнала диагностики.

Чтобы настроить параметры ведения журнала для всех API, выполните следующие действия.

  1. В меню слева экземпляра Управление API выберите API>All API.
  2. Выберите вкладку Параметры в верхней строке.
  3. Прокрутите вниз до раздела журналов диагностики и перейдите на вкладку Azure Monitor .
  4. Проверьте параметры и при необходимости внесите изменения. Выберите Сохранить.

Чтобы настроить параметры ведения журнала для определенного API, выполните следующие действия.

  1. В меню слева экземпляра Управление API выберите API и имя API.
  2. Выберите вкладку Параметры в верхней строке.
  3. Прокрутите вниз до раздела журналов диагностики и перейдите на вкладку Azure Monitor .
  4. Проверьте параметры и при необходимости внесите изменения. Выберите Сохранить.

Следующие шаги

Из этого руководства вы узнали, как:

  • просмотр метрик API;
  • настройка правила оповещения;
  • Просмотр журналов действий
  • включение и просмотр журналов ресурсов.

Перейдите к следующему руководству:

Трассировка вызовов