справочник по данным мониторинга Управление API

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

В этой статье содержатся все справочные сведения о мониторинге для этой службы.

Дополнительные сведения о данных, которые можно собирать для azure Управление API, см. в Управление API мониторинга и его использовании.

Метрики

В этом разделе перечислены все автоматически собранные метрики платформы для этой службы. Эти метрики также являются частью глобального списка всех метрик платформы, поддерживаемых в Azure Monitor.

Сведения о хранении метрик см. в обзоре метрик Azure Monitor.

Поддерживаемые метрики для Microsoft.ApiManagement/service

В следующих таблицах перечислены метрики, доступные для типа ресурса Microsoft.ApiManagement/service.

Замечание

Метрики событий Центров событий в настоящее время недоступны для уровней управления API версии 2.

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

Заголовки таблиц

  • Категория — группа метрик или классификация.
  • Метрика — отображаемое имя метрик, как оно отображается в портал Azure.
  • Имя в REST API — имя метрики, указанное в REST API.
  • Единица измерения.
  • Агрегирование — тип агрегирования по умолчанию. Допустимые значения: среднее (среднее), минимальное (минимальное), максимальное (максимальное), общее (сумма), число.
  • Измерения - , доступные для метрики.
  • Интервалы интервалов - времени, по которым выборка метрики выполняется. Например, указывает, PT1M что метрика выборка выполняется каждую минуту, каждые 30 минут, PT30MPT1H каждый час и т. д.
  • Экспорт DS— можно ли экспортировать метрики в журналы Azure Monitor с помощью параметров диагностики. Сведения об экспорте метрик см. в статье "Создание параметров диагностики" в Azure Monitor.

Категория: емкость

Метрика Имя в REST API Дополнительные метрики платформы Единица измерения Агрегат Измерения Интервалы времени Экспорт DS
Емкость

Метрика использования для службы ApiManagement. Примечание. Для номеров SKU, кроме Premium, агрегат "Max" будет показывать значение 0.
Capacity нет Процент Среднее, максимальное Location ПТ1М Да
Процент ЦП шлюза

Процент ЦП шлюза для служб SUV2
CpuPercent_Gateway нет Процент Среднее, максимальное <нет> ПТ1М Да
Процент памяти шлюза

Процент памяти шлюза для служб SUV2
MemoryPercent_Gateway нет Процент Среднее, максимальное <нет> ПТ1М Да

Категория: События EventHub

Метрика Имя в REST API Дополнительные метрики платформы Единица измерения Агрегат Измерения Интервалы времени Экспорт DS
Удаленные события EventHub

Число пропущенных событий из-за ограничения размера очереди
EventHubDroppedEvents нет Численность Сумма (Итог) Location ПТ1М Да
Отклоненные события EventHub

Число отклоненных событий EventHub (неправильная конфигурация или несанкционированный доступ)
EventHubRejectedEvents нет Численность Сумма (Итог) Location ПТ1М Да
Успешные события EventHub

Число успешных событий EventHub
EventHubSuccessfulEvents нет Численность Сумма (Итог) Location ПТ1М Да
Регулирование событий EventHub

Число событий регулировки EventHub
EventHubThrottledEvents нет Численность Сумма (Итог) Location ПТ1М Да
Время ожидания событий EventHub

Число событий с превышением времени ожидания EventHub
EventHubTimedoutEvents нет Численность Сумма (Итог) Location ПТ1М Да
Размер событий EventHub

Общий размер событий EventHub в байтах
EventHubTotalBytesSent нет Байт Сумма (Итог) Location ПТ1М Да
Всего событий EventHub

Число событий, отправленных в EventHub
EventHubTotalEvents нет Численность Сумма (Итог) Location ПТ1М Да
События EventHub сбоем

Число неудачных событий EventHub
EventHubTotalFailedEvents нет Численность Сумма (Итог) Location ПТ1М Да

Категория: запросы шлюза

Метрика Имя в REST API Дополнительные метрики платформы Единица измерения Агрегат Измерения Интервалы времени Экспорт DS
Длительность внутренних запросов

Длительность серверных запросов в миллисекундах
BackendDuration нет Миллисекунды Среднее, максимальное, минимальное Location, , HostnameApiId ПТ1М Да
Общая длительность запросов шлюза

Общая длительность запросов шлюза в миллисекундах
Duration нет Миллисекунды Среднее, максимальное, минимальное Location, , HostnameApiId ПТ1М Да
Неудачные запросы шлюза (не рекомендуется)

Число сбоев в запросах к шлюзу. Используйте метрику запроса с несколькими измерениями с измерением GatewayResponseCodeCategory
FailedRequests нет Численность Сумма (Итог) Location, Hostname ПТ1М Да
Другие запросы шлюза (не рекомендуется)

Число других запросов к шлюзу. Используйте метрику запроса с несколькими измерениями с измерением GatewayResponseCodeCategory
OtherRequests нет Численность Сумма (Итог) Location, Hostname ПТ1М Да
Запросы

Метрики запросов шлюза с несколькими измерениями
Requests нет Численность Общее (сумма), максимальное, минимальное Location, Hostname, LastErrorReasonBackendResponseCodeGatewayResponseCodeBackendResponseCodeCategoryGatewayResponseCodeCategoryApiId ПТ1М Да
Успешные запросы шлюза (не рекомендуется)

Число успешных запросов к шлюзу. Используйте метрику запроса с несколькими измерениями с измерением GatewayResponseCodeCategory
SuccessfulRequests нет Численность Сумма (Итог) Location, Hostname ПТ1М Да
Всего запросов шлюза (не рекомендуется)

Число запросов к шлюзу. Используйте метрику запроса с несколькими измерениями с измерением GatewayResponseCodeCategory
TotalRequests нет Численность Сумма (Итог) Location, Hostname ПТ1М Да
Неавторизованные запросы шлюза (не рекомендуется)

Число неавторизованных запросов к шлюзу. Используйте метрику запроса с несколькими измерениями с измерением GatewayResponseCodeCategory
UnauthorizedRequests нет Численность Сумма (Итог) Location, Hostname ПТ1М Да

Категория: Шлюз WebSocket

Метрика Имя в REST API Дополнительные метрики платформы Единица измерения Агрегат Измерения Интервалы времени Экспорт DS
Попытки подключения WebSocket (предварительная версия)

Количество попыток подключения WebSocket на основе выбранного источника и назначения
ConnectionAttempts нет Численность Общий (Сумма), Средний Location, , SourceDestinationState ПТ1М Да
Сообщения WebSocket (предварительная версия)

Количество сообщений WebSocket на основе выбранного источника и назначения
WebSocketMessages нет Численность Общий (Сумма), Средний Location, , SourceDestination ПТ1М Да

Категория: состояние сети

Метрика Имя в REST API Дополнительные метрики платформы Единица измерения Агрегат Измерения Интервалы времени Экспорт DS
Состояние сетевых подключений ресурсов (предварительная версия)

Состояние сетевых подключений для зависимых типов ресурсов из службы Управления API
NetworkConnectivity нет Численность Общий (Сумма), Средний Location, ResourceType ПТ1М Да

Измерения метрик

Дополнительные сведения о измерениях метрик см. в разделе "Многомерные метрики".

Эта служба имеет следующие измерения, связанные с ее метриками.

  • ApiId
  • КодОтветаСервера
  • BackendResponseCodeCategory
  • Назначение
  • GatewayResponseCode
  • GatewayResponseCodeCategory
  • Hostname (Имя узла)
  • ПричинаПоследнейОшибки
  • Расположение
  • ТипРесурса
  • Исходный код
  • Государство

Поддерживаемые метрики для Microsoft.ApiManagement/gateways

В следующей таблице перечислены метрики, доступные для типа ресурса Microsoft.ApiManagement/gateways.

Заголовки таблиц

Метрика — отображаемое имя метрик, как оно отображается в портал Azure. Name in Rest API - Название метрики, упоминаемой в REST API. Единица измерения. Агрегирование — тип агрегирования по умолчанию. Допустимые значения: Среднее, Минимум, Максимум, Сумма, Количество. Измерения - , доступные для метрики. Гранулы времени - Интервалы, на которых выполняется выборка метрики. Например, указывает, PT1M что метрика выборка выполняется каждую минуту, каждые 30 минут, PT30MPT1H каждый час и т. д. DS Export - Можно ли экспортировать метрику в Azure Monitor Logs через диагностические настройки.

Для получения информации об экспорте метрик см. Экспорт метрик с использованием правил сбора данных и Создание диагностических настроек в Azure Monitor.

Сведения о хранении метрик см. в обзоре метрик Azure Monitor.

Категория: использование

Метрика Имя в REST API Дополнительные метрики платформы Единица измерения Агрегат Измерения Интервалы времени Экспорт DS
Использование ЦП (%)

Общее использование процессора во всех ядрах шлюза API.
CpuPercent_Gateway нет Процент Среднее, максимальное <нет> ПТ1М Да
Использование памяти (%)

Процент физической памяти, используемой активными процессами в шлюзе API.
MemoryPercent_Gateway нет Процент Среднее, максимальное <нет> ПТ1М Да

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

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

Поддерживаемые журналы ресурсов для Microsoft.ApiManagement/service

Категория Затраты на экспорт Таблица журналов Поддерживает базовый план журнала Поддерживает преобразование времени приема Примеры запросов
DeveloperPortalAuditLogs Да Журнал аудита и диагностики портала разработчика APIM

Журналы диагностики для API портала разработчика Управление API.

Да Да
GatewayLlmLogs Да ApiManagementGatewayLlmLog

Журналы шлюза, связанные с языковыми моделями для языка управления API.

Да Да
GatewayLogs нет ApiManagementGatewayLogs

Журналы шлюза Azure ApiManagement.

Да Да Запросы
GatewayMCPLogs Да ApiManagementGatewayMCPLog

Журналы шлюза, связанные с запросами MCP.

Да нет
WebSocketConnectionLogs Да ApiManagementWebSocketConnectionLogs

Журналы подключения Websocket предоставляют журналы событий подключения websocket для шлюза Управление API. Ведение журнала начинается, когда запрос поступает в шлюз Управление API для подтверждения и до завершения запроса. Каждый журнал запросов можно однозначно идентифицировать с помощью CorrelationId.

Да нет

Поддерживаемые журналы ресурсов для Microsoft.ApiManagement/service/workspaces

Категория Затраты на экспорт Таблица журналов Поддерживает базовый план журнала Поддерживает преобразование времени приема Примеры запросов
GatewayLogs Да AzureDiagnostics

Журналы из нескольких ресурсов Azure.

нет нет

Таблицы журналов Azure Monitor

В этом разделе перечислены таблицы журналов Azure Monitor, относящиеся к этой службе, которые доступны для запроса Log Analytics с помощью запросов Kusto. Таблицы содержат данные журнала ресурсов и, возможно, больше в зависимости от собираемых и перенаправленных к ним данных.

Управление API Microsoft.ApiManagement/service

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

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

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