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

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

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

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

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

• Ознакомьтесь с терминологией службы управления API в Azure.
• Выполните задачи в кратком руководстве по созданию экземпляра службы управления API Azure.
• Также выполните задачи из руководства по импорту и публикации первого API.

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

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

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

  Совет

  На уровнях служб версии 2 и в шлюзах рабочих областей управление API заменило метрику емкости шлюза отдельными метриками использования ЦП и памяти. Эти метрики также можно использовать для масштабирования решений и устранения неполадок. Подробнее

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

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

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. В разделе Split by dimensions (Разделение по измерениям) в поле Имя измерения выберите Gateway Response Code Category (Категория кода отклика шлюза).
   4. В поле Значения измерения для таких ошибок клиента, как неавторизованные или недопустимые запросы, выберите значение 4xx. Если значение измерения не отображается, выберите "Добавить настраиваемое значение " и введите 4xx.
   5. В разделе "Когда необходимо оценить", примите параметры по умолчанию или выберите другие параметры, чтобы настроить частоту выполнения правила. Выберите Далее.

   

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

   

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

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

8. При необходимости протестируйте правило генерации оповещений с помощью HTTP-клиента для имитации запроса, который активирует оповещение. Например, выполните следующую команду в терминале, заменив имя узла Управление API именем узла экземпляра Управление API:

   curl GET https://contoso.azure-api.net/non-existent-endpoint HTTP/1.1 
   

   Триггеры оповещений основываются на периоде оценки и отправляют сообщение электронной почты [email protected].

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

   

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

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

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

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

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

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

   

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

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

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

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

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

2. В меню слева в разделе Мониторинг, выберите Параметры диагностики>+ Добавить параметр диагностики.

   

3. На странице параметров диагностики введите или выберите сведения для параметра:

   1. Имя параметра диагностики: введите описательное имя.
   2. Группы категорий. При необходимости сделайте выбор для вашего сценария.
   3. В разделе "Категории" выберите одну или несколько категорий. Например, выберите журналы, связанные с шлюзом ApiManagement , чтобы собирать журналы для большинства запросов к шлюзу управления API.
   4. В разделе "Сведения о назначении" выберите один или несколько параметров и укажите сведения о назначении. Например, отправлять журналы в рабочую область Azure Log Analytics, архивировать журналы в учетную запись хранения или передавать их в концентратор событий. Дополнительные сведения см. в разделе "Параметры диагностики" в Azure Monitor.
   5. Выберите Сохранить.

   Совет

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

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

Просмотр журналов и метрик в Azure Log Analytics

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

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

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

2. В меню слева в разделе Мониторинг выберите Журналы.

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

   ApiManagementGatewayLogs
   | where TimeGenerated > ago(1d) 
   

   

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

• Руководство по Log Analytics.
• Общие сведения о запросах к журналам в Azure Monitor.

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

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

Дополнительные сведения о параметрах ведения журнала см. в разделах "Диагностика — создание или обновление" и "Диагностика API — создание или обновление" справочных страниц REST API.

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

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

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

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

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

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

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