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

Справочник по параметрам журналов диагностики: Управление API

  • Статья

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

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

Примечание.

Некоторые параметры, отмеченные, применяются только к ведению журнала в Application Insights.

Параметр Тип Описание
Включить boolean Указывает, включено ли ведение журнала для данного API.

Ведение журнала можно включить для всех API или отдельного API. Параметры для отдельных параметров API переопределяются для всех API, если он включен.
Назначение Средство ведения журнала Azure Application Insights Указывает средство ведения журнала, используемое для ведения журнала Application Insights.
Выборка (%) десятичное Значения от 0 до 100 (в процентах).
Указывает процент зарегистрированных запросов. Выборка в 0 % означает, что в журнал не будет записан ни один запрос, а выборка в 100 % — что в журнал будут записаны все запросы. По умолчанию — 100

Сведения о влиянии на производительность ведения журнала Application Insights см. в статье о последствиях производительности и выборке журналов.
Всегда записывать ошибки в журнал boolean Если этот параметр включен, все ошибки регистрируются независимо от параметра выборки .
IP-адрес клиента журнала boolean Если этот параметр включен, IP-адрес клиента для запросов API регистрируется.
Уровень детализации Указывает детализацию журналов и регистрируются ли пользовательские трассировки, настроенные в политиках трассировки .

* Ошибка — неудачные запросы и пользовательские трассировки серьезности error
* Сведения — неудачные и успешные запросы, а также пользовательские трассировки серьезности error и information
* Подробные сведения — неудачные и успешные запросы, а также пользовательские трассировки серьезности error, informationи verbose

Сведения по умолчанию.
Протокол корреляции Указывает протокол, используемый для корреляции телеметрии, отправляемой несколькими компонентами в Application Insights. По умолчанию: устаревшая версия

Дополнительные сведения см. в статье Корреляция данных телеметрии в Application Insights.
Заголовки для журнала список Указывает заголовки, которые регистрируются для запросов и ответов. По умолчанию: заголовки не записываются в журналы.
Количество полезных данных (текст) в журнал integer Указывает количество начальных байтов внешнего или внутреннего запроса или текста ответа, зарегистрированного в журнале. Максимум: 8 192. По умолчанию: 0
Запрос к интерфейсу Указывает, регистрируются ли интерфейсные запросы (входящие запросы к шлюзу Управление API).

Если этот параметр включен, укажите заголовки для журнала, количество полезных данных в журнал или оба параметра.
Ответ интерфейса Указывает, регистрируются ли ответы внешнего интерфейса (исходящие ответы из шлюза Управление API).

Если этот параметр включен, укажите заголовки для журнала, количество полезных данных в журнал или оба параметра.
Запрос к серверу Указывает, регистрируются ли внутренние запросы (исходящие запросы из шлюза Управление API).

Если этот параметр включен, укажите заголовки для журнала, количество полезных данных в журнал или оба параметра.
Ответ сервера Указывает, регистрируются ли ответы серверной части (входящие в шлюз Управление API).

Если этот параметр включен, укажите заголовки для журнала, количество полезных данных в журнал или оба параметра.

Внимание

Если этот параметр включен, полезные данные запроса или ответа в журнале могут составлять до 8 192 байт. Управление API также применяет ограничение в 32 КБ для записи журнала диагностики, отправленной в Azure Monitor, которая включает полезные данные и другие атрибуты, такие как коды состояния, заголовки и метки времени. Если совокупный размер атрибутов превышает 32 КБ, Управление API обрезает запись, удалив все содержимое текста и трассировки.

Следующие шаги