Примечание
Для доступа к этой странице требуется авторизация. Вы можете попробовать войти или изменить каталоги.
Для доступа к этой странице требуется авторизация. Вы можете попробовать изменить каталоги.
ОБЛАСТЬ ПРИМЕНЕНИЯ: все уровни Управление API
Политика emit-metric
отправляет пользовательские метрики определенного формата в Application Insights.
Note
Задайте элементы политики и дочерние элементы в порядке, указанном в правиле политики. Узнайте, как устанавливать или изменять политики службы управления API.
Ограничения для пользовательских метрик
Azure Monitor накладывает ограничения на использование пользовательских метрик, которые могут повлиять на возможность отправки метрик из Управление API. Например, Azure Monitor в настоящее время задает ограничение в 10 ключей измерений на метрики и ограничение в 50 000 активных временных рядов в каждом регионе в подписке (в течение 12 часов). В службе управления API 5 из них используются для измерений по умолчанию, включая следующие:
- Region
- Service ID
- Service Name
- Service Type
Эти ограничения имеют следующие последствия для настройки пользовательских метрик в политике Управление API, напримерemit-metric
:azure-openai-emit-token-metric
Можно настроить не более 5 пользовательских измерений для каждой политики.
Число активных временных рядов, создаваемых политикой в течение 12 часов, является продуктом числа уникальных значений каждого настроенного измерения в течение периода. Например, если в политике настроены три пользовательских измерения, а каждое измерение имеет 10 возможных значений в течение периода, политика будет способствовать 1000 (10 x 10 x 10) активных временных рядов.
Если вы настраиваете политику в нескольких экземплярах Управление API, которые находятся в одном регионе в подписке, все экземпляры могут способствовать ограничению активных временных рядов региона.
Дополнительные сведения об ограничениях проектирования и рекомендациях по пользовательским метрикам в Azure Monitor.
Prerequisites
- Экземпляр Управление API должен быть интегрирован с Application Insights. Дополнительные сведения см. в статье "Интеграция Azure Управление API с приложение Azure Insights".
- Включите ведение журнала Application Insights для API.
- Включите пользовательские метрики с измерениями в Application Insights. Дополнительные сведения см. в разделе "Выдача пользовательских метрик".
Policy statement
<emit-metric name="name of custom metric" value="value of custom metric" namespace="metric namespace">
<dimension name="dimension name" value="dimension value" />
</emit-metric>
Attributes
Attribute | Description | Required | Default value |
---|---|---|---|
name | A string. Имя пользовательской метрики. Выражения политики не допускаются. | Yes | N/A |
namespace | A string. Пространство имен пользовательской метрики. Выражения политики не допускаются. | No | API Management |
value | Значение пользовательской метрики, выраженное как двойное. Допустимы выражения политики. | No | 1 |
Elements
Element | Description | Required |
---|---|---|
dimension | Добавьте один или несколько этих элементов для каждого измерения, входящего в настраиваемую метрику. | Yes |
Dimension attributes
Attribute | Description | Required | Default value |
---|---|---|---|
name | Строковое выражение или выражение политики. Имя измерения. | Yes | N/A |
value | Строковое выражение или выражение политики. Значение измерения. Можно опустить, только если name соответствует одному из измерений по умолчанию. Если это так, значение указывается в соответствии с именем измерения. |
No | N/A |
Имена измерений по умолчанию, которые могут использоваться без значения
- API ID
- Operation ID
- Product ID
- User ID
- Subscription ID
- Location
- Gateway ID
- Идентификатор серверной части (используйте только в разделе политики исходящего трафика)
Usage
- Разделы политики: inbound, outbound, backend, on-error.
- Области политики: глобальная, рабочая область, продукт, API, операция
- Шлюзы: классическая, версия 2, потребление, локальное размещение, рабочая область
Usage notes
- Для этой политики можно настроить не более 5 пользовательских измерений.
Example
В следующем примере пользовательская метрика отправляется для подсчета количества запросов API вместе с идентификатором API в качестве измерения по умолчанию.
<policies>
<inbound>
<emit-metric name="Request" value="1" namespace="my-metrics">
<dimension name="API ID" />
</emit-metric>
</inbound>
<outbound>
</outbound>
</policies>
Related policies
Related content
Дополнительные сведения о работе с политиками см. в нижеуказанных статьях.
- Руководство. Преобразование и защита API
- Полный перечень операторов политик и их параметров см. в справочнике по политикам.
- Policy expressions
- Настройка или изменение политик
- Повторное использование конфигураций политик
- Репозиторий фрагментов политик
- Репозиторий игровой площадки политики
- Набор средств политики Управление API Azure
- Получите помощь Copilot для создания, объяснения и устранения неполадок в политике