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


Клиентская библиотека Azure Logger для JavaScript — версия 1.2.0

Пакет @azure/logger можно использовать для включения ведения журнала в Azure SDK для JavaScript.

Ведение журнала можно включить для пакета SDK Azure следующим образом:

  • Настройка переменной среды AZURE_LOG_LEVEL
  • Вызов setLogLevel, импортированный из "@azure/loger"
  • Включение вызова () для определенных средств ведения журнала
  • Использование переменной окружения DEBUG .

Обратите внимание, что AZURE_LOG_LEVEL, если задано, имеет приоритет над DEBUG. Используйте отладку только без указания AZURE_LOG_LEVEL или вызова setLogLevel.

Начало работы

Установка

Установите эту библиотеку с помощью npm следующим образом.

npm install @azure/logger

Основные понятия

Пакет @azure/logger поддерживает следующие уровни ведения журнала, указанные в порядке от наиболее подробных к наименее подробным:

  • многословный
  • информация
  • предупреждение
  • ошибка

При установке уровня журнала, программным способом или с помощью переменной AZURE_LOG_LEVEL среды, будут выдаваться любые журналы, записанные с использованием уровня журнала, равного или меньшего выбранного вами.

Например, установка уровня журнала приведет к warning тому, что все журналы, имеющие этот уровень warning или error будут выданы.

ПРИМЕЧАНИЕ: При протоколировании запросов и ответов мы очищаем эти объекты, чтобы убедиться, что такие вещи, как Authorization заголовки, содержащие секреты, не регистрируются.

Тела запросов и ответов никогда не регистрируются. Заголовки по умолчанию редактируются, если в следующем списке или явно не разрешено клиентским пакетом SDK:

  • "x-ms-client-request-id",
  • "x-ms-return-client-request-id",
  • "x-ms-useragent",
  • "x-ms-correlation-request-id",
  • "x-ms-request-id",
  • "идентификатор клиента-запроса",
  • «ms-cv»,
  • "return-client-request-id",
  • "traceparent",
  • "Доступ-Контроль-Разрешение-Учетные Данные",
  • "Доступ-Контроль-Разрешенные Заголовки",
  • "Методы доступа-Управления-Разрешения",
  • "Доступ-Контроль-Разрешение-Источник",
  • "Доступ-Контроль-Экспозе-Заголовки",
  • "Доступ-Контроль-Макс-Возраст",
  • "Заголовки запросов доступа",
  • "Метод запроса доступа",
  • "Источник",
  • "Принять",
  • "Принятие-кодирование",
  • "Управление кэшем",
  • "Подключение",
  • "Содержание-Длина",
  • "Content-Type",
  • "Дата",
  • ETag,
  • "Истекает срок действия",
  • "Если-Матч",
  • "если-изменено-с",
  • "Если-Ни-Соответствуй",
  • "Если-Неизмененный-С",
  • "Последнее изменение",
  • «Прагма»,
  • "Идентификатор запроса",
  • "Повторная попытка",
  • "Сервер",
  • "Передача кодирования",
  • "User-Agent",
  • "WWW-authenticate",

Примеры

Пример 1. Базовое использование

import { setLogLevel } from "@azure/logger";

setLogLevel("info");

Пример 2. Выходные данные журнала перенаправления

import { setLogLevel, AzureLogger } from "@azure/logger";

setLogLevel("verbose");

// override logging to output to console.log (default location is stderr)
AzureLogger.log = (...args) => {
  console.log(...args);
};

С помощью AzureLogger, можно перенаправить выходные данные ведения журнала из Azure SDK, переопределив метод.AzureLogger.log Это может быть полезно, если вы хотите перенаправить журналы в расположение, отличное от stderr.

Дальнейшие действия

Вы можете создать и запустить тесты локально, выполнив rushx test. Изучите папку test, чтобы просмотреть расширенное использование и поведение общедоступных классов.

Устранение неполадок

Если при использовании этой библиотеки возникают проблемы, вы можете файл проблемы.

Способствует

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