Поделиться через


Трассировка

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

Политика trace добавляет пользовательскую трассировку в выходные данные трассировки запросов в тестовой консоли, телеметрии Application Insights и (или) журналы ресурсов.

  • Политика добавляет настраиваемую трассировку в выходные данные трассировки запроса в консоли тестирования при активации трассировки.
  • Политика создает телеметрию трассировки в Application Insights, если включена интеграция Application Insights, а severity указанная в политике равна или больше указанного verbosity в параметре диагностики.
  • Политика добавляет свойство в запись журнала при включении журналов ресурсов, а уровень серьезности, указанный в политике, равен уровню детализации, указанному в параметре диагностики.
  • На политику не влияет выборка Application Insights. Все вызовы политики регистрируются в журнале.

Внимание

  • Управление API трассировке запросов с помощью Заголовок Ocp-Apim-Trace в запросе и использование значения заголовка ответа Ocp-Apim-Trace-Location не рекомендуется.
  • Чтобы повысить безопасность, теперь трассировку можно включить на уровне отдельного API, получив ограниченный по времени маркер с помощью REST API Управление API и передав маркер в запросе шлюзу. Дополнительные сведения см. в разделе "Включение трассировки API".
  • Следите за включением трассировки, так как она может предоставлять конфиденциальную информацию в данных трассировки. Убедитесь, что у вас есть соответствующие меры безопасности для защиты данных трассировки.

Примечание.

Задайте элементы политики и дочерние элементы в порядке, указанном в правиле политики. Узнайте, как устанавливать или изменять политики службы управления API.

Правило политики

<trace source="arbitrary string literal" severity="verbose | information | error">
    <message>String literal or expressions</message>
    <metadata name="string literal or expressions" value="string literal or expressions"/>
</trace>

Атрибуты

Атрибут Description Обязательное поле По умолчанию.
source Строковый литерал, понятный средству просмотра трассировки и указывающий источник сообщения. Выражения политики не допускаются. Да Н/П
severity Указывает степень серьезности трассировки. Допустимые значения: verbose, information, error (от нижнего к верхнему). Выражения политики не допускаются. No verbose

Элементы

Имя Описание Обязательное поле
message Строка или выражение для записи в журнал. Допустимы выражения политики. Да
metadata Добавляет пользовательское свойство в данные телеметрии трассировки Application Insights. No

Атрибуты метаданных

Атрибут Description Обязательное поле По умолчанию.
name Имя свойства. Да Н/П
значение Значение свойства. Да Н/П

Использование

Пример

<trace source="PetStore API" severity="verbose">
    <message>@((string)context.Variables["clientConnectionID"])</message>
    <metadata name="Operation Name" value="New-Order"/>
</trace>

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