ログ記録

環境変数

次の環境変数の 1 つ以上で重大度レベルを指定することで、ドライバーのさまざまなコンポーネントのログ記録を構成できます。

• MONGODB_LOG_ALL: 設定されていないコンポーネントのデフォルトの重大度を指定します

• MONGODB_LOG_COMMAND:サーバーに送信されたすべてのコマンドをログに記録

• MONGODB_LOG_TOPOLOGY: クラスタートポロジーの変更をログに記録

• MONGODB_LOG_SERVER_SELECTION:サーバー選択プロセスをログに記録

• MONGODB_LOG_CONNECTION: すべての接続プールイベントをログに記録

• MONGODB_LOG_CLIENT: すべてのクライアントイベントをログに記録

上記の環境変数を指定しない場合、ドライバーは MONGODB_LOG_ALL の値を使用します。指定されていない場合は、暗黙的に off に設定されます。

次の例では、MONGODB_LOG_COMMAND を除くすべてのコンポーネントのログレベルを debug に設定します。

export MONGODB_LOG_ALL="debug"
export MONGODB_LOG_COMMAND="off"

export MONGODB_LOG_PATH="stderr"

export MONGODB_LOG_MAX_DOCUMENT_LENGTH=500

クライアント オプション

MongoClient コンストラクターでクライアントオプションを指定することで、プログラムでログを構成できます。クライアントオプションは環境変数よりも優先されるため、ドライバーが環境変数に応答しないようにしたい場合にのみ、クライアント内で指定します。

ログ記録を構成するコンポーネントを指定するには、次のクライアントオプションを 1 つ以上指定します。

• default: 設定されていないコンポーネントのデフォルトの重大度を指定します

• command:サーバーに送信されたすべてのコマンドをログに記録

• topology: クラスタートポロジーの変更をログに記録

• serverSelection:サーバー選択プロセスをログに記録

• connection: すべての接続プールイベントをログに記録

• client: すべてのクライアントイベントをログに記録

コンポーネントのログレベルを指定するには、コンポーネントと希望する重大度レベルを含むオブジェクトに mongodbLogComponentSeverities オプションを設定します。次の例では、command を除くすべてのコンポーネントのログレベルを debug に設定します。

const client = new MongoClient("<connection string>", {
    mongodbLogComponentSeverities: {
        default: "debug",
        command: "off"
    }
});

const mongodbLogComponentSeverities = {
    default: "debug"
};
const mongodbLogPath = "stdout";
const client = new MongoClient("<connection string>",
    { mongodbLogComponentSeverities, mongodbLogPath }
);

import fs from 'node:fs/promises';
import util from 'node:util';
const mongodbLogPath = {
    file: await fs.open(`./server-${+new Date()}.logs`, 'w'),
    async write(log) {
        try {
            await this.file?.appendFile(util.inspect(log) + '\n');
        } catch (fileError) {
            console.log('cannot log anymore', fileError);
            this.file = null;
        }
    }
}
const client = new MongoClient("<connection string>", { mongodbLogPath });

const mongodbLogComponentSeverities = {
    default: "debug"
};
const mongodbLogLength = 500;
const client = new MongoClient("<connection string>", {
    mongodbLogComponentSeverities,
    mongodbLogLength
});

API ドキュメント

このガイドで説明したオプションやタイプの詳細については、次のAPIドキュメントを参照してください。

• MongoClientOptions

• mongodbLogComponentSeverity

• mongodbLogMaxDocumentLength

• mongodbLogPath