справочник по данным мониторинга Управление API
ОБЛАСТЬ ПРИМЕНЕНИЯ: все уровни Управление API
В этой статье содержатся все справочные сведения о мониторинге для этой службы.
Дополнительные сведения о данных, которые можно собирать для azure Управление API, см. в Управление API мониторинга и его использовании.
Метрики
В этом разделе перечислены все автоматически собранные метрики платформы для этой службы. Эти метрики также являются частью глобального списка всех метрик платформы, поддерживаемых в Azure Monitor.
Сведения о хранении метрик см. в обзоре метрик Azure Monitor.
Поддерживаемые метрики для Microsoft.ApiManagement/service
В следующей таблице перечислены метрики, доступные для типа ресурса Microsoft.ApiManagement/service.
- Все столбцы могут не присутствовать в каждой таблице.
- Некоторые столбцы могут находиться за пределами области просмотра страницы. Выберите "Развернуть таблицу ", чтобы просмотреть все доступные столбцы.
Заголовки таблиц
- Категория — группа метрик или классификация.
- Метрика — отображаемое имя метрик, как оно отображается в портал Azure.
- Имя в REST API — имя метрики, указанное в REST API.
- Единица измерения.
- Агрегирование — тип агрегирования по умолчанию. Допустимые значения: среднее (среднее), минимальное (минимальное), максимальное (максимальное), общее (сумма), число.
- Измерения - , доступные для метрики.
- Интервалы интервалов - времени, по которым выборка метрики выполняется. Например, указывает,
PT1M
что метрика выборка выполняется каждую минуту, каждые 30 минут,PT30M
PT1H
каждый час и т. д. - Экспорт DS— можно ли экспортировать метрики в журналы Azure Monitor с помощью параметров диагностики. Сведения об экспорте метрик см. в статье "Создание параметров диагностики" в Azure Monitor.
Категория | Метрика | Имя в REST API | Единица измерения | Агрегат | Измерения | Интервалы времени | Экспорт DS |
---|---|---|---|---|---|---|---|
Запросы к шлюзу | Длительность внутренних запросов Длительность серверных запросов в миллисекундах |
BackendDuration |
MilliSeconds | Среднее, максимальное, минимальное | Location , , Hostname ApiId |
PT1M | Да |
Capacity | Емкость Метрика использования для службы ApiManagement. Примечание. Для номеров SKU, кроме Premium, агрегат "Max" будет показывать значение 0. |
Capacity |
Процент | Среднее, максимальное | Location |
PT1M | Да |
Шлюз WebSocket | Попытки подключения WebSocket (предварительная версия) Количество попыток подключения WebSocket на основе выбранного источника и назначения |
ConnectionAttempts |
Count | Total (Sum), Average | Location , , Source Destination State |
PT1M | Да |
Capacity | Процент ЦП шлюза Процент ЦП шлюза для служб SUV2 |
CpuPercent_Gateway |
Процент | Среднее, максимальное | <none> | PT1M | Да |
Запросы к шлюзу | Общая длительность запросов шлюза Общая длительность запросов шлюза в миллисекундах |
Duration |
MilliSeconds | Среднее, максимальное, минимальное | Location , , Hostname ApiId |
PT1M | Да |
События EventHub | Удаленные события EventHub Число пропущенных событий из-за ограничения размера очереди |
EventHubDroppedEvents |
Count | Total (Sum) | Location |
PT1M | Да |
События EventHub | Отклоненные события EventHub Число отклоненных событий EventHub (неправильная конфигурация или несанкционированный доступ) |
EventHubRejectedEvents |
Count | Total (Sum) | Location |
PT1M | Да |
События EventHub | Успешные события EventHub Число успешных событий EventHub |
EventHubSuccessfulEvents |
Count | Total (Sum) | Location |
PT1M | Да |
События EventHub | Регулирование событий EventHub Число событий регулировки EventHub |
EventHubThrottledEvents |
Count | Total (Sum) | Location |
PT1M | Да |
События EventHub | Время ожидания событий EventHub Число событий с превышением времени ожидания EventHub |
EventHubTimedoutEvents |
Count | Total (Sum) | Location |
PT1M | Да |
События EventHub | Размер событий EventHub Общий размер событий EventHub в байтах |
EventHubTotalBytesSent |
Байт | Total (Sum) | Location |
PT1M | Да |
События EventHub | Всего событий EventHub Число событий, отправленных в EventHub |
EventHubTotalEvents |
Count | Total (Sum) | Location |
PT1M | Да |
События EventHub | События EventHub сбоем Число неудачных событий EventHub |
EventHubTotalFailedEvents |
Count | Total (Sum) | Location |
PT1M | Да |
Запросы к шлюзу | Неудачные запросы шлюза (не рекомендуется) Число сбоев в запросах к шлюзу. Используйте метрику запроса с несколькими измерениями с измерением GatewayResponseCodeCategory |
FailedRequests |
Count | Total (Sum) | Location , Hostname |
PT1M | Да |
Capacity | Процент памяти шлюза Процент памяти шлюза для служб SUV2 |
MemoryPercent_Gateway |
Процент | Среднее, максимальное | <none> | PT1M | Да |
Состояние сети | Состояние сетевых подключений ресурсов (предварительная версия) Состояние сетевых подключений для зависимых типов ресурсов из службы Управления API |
NetworkConnectivity |
Count | Total (Sum), Average | Location , ResourceType |
PT1M | Да |
Запросы к шлюзу | Другие запросы шлюза (не рекомендуется) Число других запросов к шлюзу. Используйте метрику запроса с несколькими измерениями с измерением GatewayResponseCodeCategory |
OtherRequests |
Count | Total (Sum) | Location , Hostname |
PT1M | Да |
Запросы к шлюзу | Запросы Метрики запросов шлюза с несколькими измерениями |
Requests |
Count | Общее (сумма), максимальное, минимальное | Location , Hostname , LastErrorReason BackendResponseCode GatewayResponseCode BackendResponseCodeCategory GatewayResponseCodeCategory ApiId |
PT1M | Да |
Запросы к шлюзу | Успешные запросы шлюза (не рекомендуется) Число успешных запросов к шлюзу. Используйте метрику запроса с несколькими измерениями с измерением GatewayResponseCodeCategory |
SuccessfulRequests |
Count | Total (Sum) | Location , Hostname |
PT1M | Да |
Запросы к шлюзу | Всего запросов шлюза (не рекомендуется) Число запросов к шлюзу. Используйте метрику запроса с несколькими измерениями с измерением GatewayResponseCodeCategory |
TotalRequests |
Count | Total (Sum) | Location , Hostname |
PT1M | Да |
Запросы к шлюзу | Неавторизованные запросы шлюза (не рекомендуется) Число неавторизованных запросов к шлюзу. Используйте метрику запроса с несколькими измерениями с измерением GatewayResponseCodeCategory |
UnauthorizedRequests |
Count | Total (Sum) | Location , Hostname |
PT1M | Да |
Шлюз WebSocket | Сообщения WebSocket (предварительная версия) Количество сообщений WebSocket на основе выбранного источника и назначения |
WebSocketMessages |
Count | Total (Sum), Average | Location , , Source Destination |
PT1M | Да |
Измерения метрик
Дополнительные сведения о измерениях метрик см. в разделе "Многомерные метрики".
Эта служба имеет следующие измерения, связанные с ее метриками.
- ApiId
- BackendResponseCode
- BackendResponseCodeCategory
- Назначение
- GatewayResponseCode
- GatewayResponseCodeCategory
- Hostname (Имя узла)
- LastErrorReason
- Расположение
- ResourceType
- Исходный код
- Штат
Журналы ресурсов
В этом разделе перечислены типы журналов ресурсов, которые можно собирать для этой службы. Раздел извлекает из списка всех типов категорий журналов ресурсов, поддерживаемых в Azure Monitor.
Поддерживаемые журналы ресурсов для Microsoft.ApiManagement/service
Категория | Отображаемое имя категории | Таблица журналов | Поддерживает базовый план журнала | Поддерживает преобразование времени приема | Примеры запросов | Затраты на экспорт |
---|---|---|---|---|---|---|
DeveloperPortalAuditLogs |
Журналы, связанные с использованием портала разработчика | APIMDevPortalAuditDiagnosticLog Журналы диагностики для API портала разработчика Управление API. |
Да | No | Да | |
GatewayLlmLogs |
Журналы, связанные с созданным шлюзом ИИ | No | No | Да | ||
GatewayLogs |
Журналы, относящихся к шлюзу ApiManagement. | ApiManagementGatewayLogs Журналы шлюза Azure ApiManagement. |
Да | Да | Запросы | No |
WebSocketConnectionLogs |
Журналы, относящиеся к подключениям WebSocket. | ApiManagementWebSocketConnectionLogs Журналы подключения Websocket предоставляют журналы событий подключения websocket для шлюза Управление API. Ведение журнала начинается, когда запрос поступает в шлюз Управление API для подтверждения и до завершения запроса. Каждый журнал запросов можно однозначно идентифицировать с помощью CorrelationId. |
Да | No | Да |
Поддерживаемые журналы ресурсов для Microsoft.ApiManagement/service/workspaces
Категория | Отображаемое имя категории | Таблица журналов | Поддерживает базовый план журнала | Поддерживает преобразование времени приема | Примеры запросов | Затраты на экспорт |
---|---|---|---|---|---|---|
GatewayLogs |
Журналы шлюза для рабочих областей Управление API | No | No | Да |
Таблицы журналов Azure Monitor
В этом разделе перечислены таблицы журналов Azure Monitor, относящиеся к этой службе, которые доступны для запроса Log Analytics с помощью запросов Kusto. Таблицы содержат данные журнала ресурсов и, возможно, больше в зависимости от собираемых и перенаправленных к ним данных.
Управление API Microsoft.ApiManagement/service
- APIMDevPortalAuditDiagnosticLog
- AzureActivity
- AzureMetrics
- AzureDiagnostics
- ApiManagementGatewayLogs
- ApiManagementWebSocketConnectionLogs
Журнал действий
В связанной таблице перечислены операции, которые можно записать в журнале действий для этой службы. Эти операции представляют собой подмножество всех возможных операций поставщика ресурсов в журнале действий.
Дополнительные сведения о схеме записей журнала действий см . в схеме журнала действий.
Связанный контент
- Сведения о мониторинге Управление API Azure см. в статье "Мониторинг Управление API".
- Дополнительные сведения о мониторинге ресурсов Azure см. в статье "Мониторинг ресурсов Azure" с помощью Azure Monitor .