Создание пользовательских метрик
ОБЛАСТЬ ПРИМЕНЕНИЯ: все уровни Управление API
Политика emit-metric
отправляет пользовательские метрики определенного формата в Application Insights.
Примечание.
Задайте элементы политики и дочерние элементы в порядке, указанном в правиле политики. Узнайте, как устанавливать или изменять политики службы управления API.
Ограничения для пользовательских метрик
Azure Monitor накладывает ограничения на использование пользовательских метрик, которые могут повлиять на возможность отправки метрик из Управление API. Например, Azure Monitor в настоящее время задает ограничение в 10 ключей измерений на метрики и ограничение в 50 000 активных временных рядов в каждом регионе в подписке (в течение 12 часов).
Эти ограничения имеют следующие последствия для настройки пользовательских метрик в политике Управление API, напримерemit-metric
:azure-openai-emit-token-metric
Можно настроить не более 10 пользовательских измерений для каждой политики.
Число активных временных рядов, создаваемых политикой в течение 12 часов, является продуктом числа уникальных значений каждого настроенного измерения в течение периода. Например, если в политике настроены три пользовательских измерения, а каждое измерение имеет 10 возможных значений в течение периода, политика будет способствовать 1000 (10 x 10 x 10) активных временных рядов.
Если вы настраиваете политику в нескольких экземплярах Управление API, которые находятся в одном регионе в подписке, все экземпляры могут способствовать ограничению активных временных рядов региона.
Дополнительные сведения об ограничениях проектирования и рекомендациях по пользовательским метрикам в Azure Monitor.
Необходимые компоненты
- Экземпляр Управление API должен быть интегрирован с Application Insights. Дополнительные сведения см. в статье "Интеграция Azure Управление API с приложение Azure Insights".
- Включите ведение журнала Application Insights для API.
- Включите пользовательские метрики с измерениями в Application Insights. Дополнительные сведения см. в разделе "Выдача пользовательских метрик".
Правило политики
<emit-metric name="name of custom metric" value="value of custom metric" namespace="metric namespace">
<dimension name="dimension name" value="dimension value" />
</emit-metric>
Атрибуты
Атрибут | Description | Обязательное поле | Default value |
---|---|---|---|
name | Строка . Имя пользовательской метрики. Выражения политики не допускаются. | Да | Н/П |
пространство имен | Строка . Пространство имен пользовательской метрики. Выражения политики не допускаются. | No | Управление API |
значение | Значение пользовательской метрики, выраженное как двойное. Допустимы выражения политики. | No | 1 |
Элементы
Элемент | Description | Обязательное поле |
---|---|---|
измерение | Добавьте один или несколько этих элементов для каждого измерения, входящего в настраиваемую метрику. | Да |
Атрибуты измерения
Атрибут | Description | Обязательное поле | Default value |
---|---|---|---|
name | Строковое выражение или выражение политики. Имя измерения. | Да | Н/П |
значение | Строковое выражение или выражение политики. Значение измерения. Можно опустить, только если name соответствует одному из измерений по умолчанию. Если это так, значение указывается в соответствии с именем измерения. |
No | Н/П |
Имена измерений по умолчанию, которые могут использоваться без значения
- Идентификатор API
- Идентификатор операции
- Код продукта
- Идентификатор пользователя
- ИД подписки
- Расположение
- Идентификатор шлюза
Использование
- Разделы политики: inbound, outbound, backend, on-error.
- Области политики: глобальная, рабочая область, продукт, API, операция
- Шлюзы: классическая, версия 2, потребление, локальное размещение, рабочая область
Примечания об использовании
- Для этой политики можно настроить не более 10 пользовательских измерений.
Пример
В следующем примере пользовательская метрика отправляется для подсчета количества запросов API вместе с идентификатором API в качестве настраиваемого измерения.
<policies>
<inbound>
<emit-metric name="Request" value="1" namespace="my-metrics">
<dimension name="API ID" />
</emit-metric>
</inbound>
<outbound>
</outbound>
</policies>
Связанные политики
Связанный контент
Дополнительные сведения о работе с политиками см. в нижеуказанных статьях.
- Руководство. Преобразование и защита API
- Полный перечень операторов политик и их параметров см. в справочнике по политикам.
- Выражения политики
- Настройка или изменение политик
- Повторное использование конфигураций политик
- Репозиторий фрагментов политик
- Создание политик с помощью Microsoft Copilot в Azure