次の方法で共有


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

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

ログ記録は、次の方法で 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 パッケージは、詳細度の高いものから低いものの順に指定された次のログレベルをサポートしています。

  • 冗長
  • 情報
  • 警告
  • エラー

プログラムまたは 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-Origin"、
  • "Access-Control-Expose-Headers"、
  • "アクセス制御-最大経過時間"、
  • "Access-Control-Request-Headers"、
  • "Access-Control-Request-Method"、
  • 「起源」、
  • 「受け入れる」、
  • "Accept-Encoding"、
  • "Cache-Control"、
  • 「接続」、
  • "Content-Length"、
  • "Content-Type"、
  • "日付",
  • "ETag"、
  • "有効期限"、
  • "If-Match"、
  • "If-Modified-Since"、
  • "If-None-Match"、
  • "If-Unmodified-Since"、
  • "最終更新日"、
  • 「プラグマ」、
  • "Request-Id"、
  • "Retry-After"、
  • "サーバー"、
  • "Transfer-Encoding"、
  • "User-Agent"、
  • 「WWW-認証」、

例 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 フォルダーを調べて、パブリック クラスの高度な使用方法と動作を確認します。

トラブルシューティング

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

貢献

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