适用于 JavaScript 的 Azure Logger 客户端库 - 版本 1.2.0

该 @azure/logger 包可用于在适用于 JavaScript 的 Azure SDK 中启用日志记录。

可以通过以下方式为 Azure SDK 启用日志记录：

• 设置AZURE_LOG_LEVEL环境变量
• 调用从“@azure/记录器”导入的 setLogLevel
• 在特定记录器上调用 enable（）
• DEBUG使用环境变量。

请注意，AZURE_LOG_LEVEL（如果设置）优先于 DEBUG。 仅使用 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”，
• “client-request-id”，
• “ms-cv”，
• “return-client-request-id”，
• “traceparent”，
• “Access-Control-Allow-Credentials”，
• “Access-Control-Allow-Headers”，
• “Access-Control-Allow-Methods”，
• “Access-Control-Allow-Origin”，
• “Access-Control-Expose-Headers”，
• “Access-Control-Max-Age”，
• “Access-Control-Request-Headers”，
• “Access-Control-Request-Method”，
• “Origin”，
• “Accept”，
• “Accept-Encoding”，
• “Cache-Control”，
• “连接”，
• “Content-Length”，
• “Content-Type”，
• “Date”，
• “ETag”，
• “Expires”，
• “If-Match”，
• “If-Modified-Since”，
• “If-None-Match”，
• “If-Unmodified-Since”，
• “Last-Modified”，
• “Pragma”，
• “Request-Id”，
• “Retry-After”，
• “Server”，
• “Transfer-Encoding”，
• “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，可以通过重写 AzureLogger.log 该方法来重定向 Azure SDK 的日志记录输出。 如果要将日志重定向到 stderr 以外的位置，这可能很有用。

后续步骤

可以通过执行 rushx test在本地生成和运行测试。 浏览 test 文件夹以查看公共类的高级用法和行为。

故障 排除

如果在使用此库时遇到问题，请随时 提交问题。

贡献

若要参与此库，请阅读 参与指南 ，详细了解如何生成和测试代码。