JavaScript 用 Azure Logger クライアント ライブラリ - バージョン 1.1.2

@azure/logger パッケージを使用すると、JavaScript 用 Azure SDK のログ記録を有効にすることができます。

Azure SDK のログ記録は、次の方法で有効にすることができます。

• AZURE_LOG_LEVEL 環境変数の設定
• "@azure/logger" からインポートされた setLogLevel の呼び出し
• 特定のロガーでの enable() の呼び出し
• DEBUG 環境変数の使用。

AZURE_LOG_LEVEL が設定されている場合、DEBUG よりも優先されることに注意してください。 AZURE_LOG_LEVEL の指定や setLogLevel の呼び出しを行うことなく、DEBUG のみを使用します。

作業の開始

インストール

次のように npm を使用してこのライブラリをインストールします

npm install @azure/logger

主要概念

@azure/logger パッケージでは、詳細度が最も高いものから最も低いものの順に指定された、次のログ レベルがサポートされています。

• verbose
• info
• warning
• error

プログラムで、または 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",
• "Connection",
• "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 - 基本的な使用方法

const { EventHubClient } = require('@azure/event-hubs');

const logger = require('@azure/logger');
logger.setLogLevel('info');

// operations will now emit info, warning, and error logs
const client = new EventHubClient(/* params */);
client.getPartitionIds()
  .then(ids => { /* do work */ })
  .catch(e => { /* do work */ });
});

例 2 - ログ出力のリダイレクト

const { AzureLogger, setLogLevel } = require("@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 フォルダーを調べて、パブリック クラスの高度な使用状況と動作を確認します。

トラブルシューティング

このライブラリの使用中に問題が発生した場合は、お気軽に問題を提出してください。

共同作成

このライブラリに投稿する場合、コードをビルドしてテストする方法の詳細については、投稿ガイドを参照してください。