Database Profiler

グローバルおよびデータベースごとのプロファイリング設定

slowms および sampleRate の両プロファイリング設定はグローバルです。これらを設定すると、プロセス内のすべてのデータベースに影響します。

profileコマンドまたはdb.setProfilingLevel() shellヘルパー メソッドで設定すると、プロファイリング レベルとフィルター設定はデータベースレベルで設定されます。 コマンドライン オプションまたは構成ファイルオプションのいずれかとして設定すると、プロファイリング レベルとfilter設定はプロセス全体に影響します。

低速操作のしきい値を指定

デフォルトでは、低速操作のしきい値は 100 ミリ秒です。

低速操作は、MongoDB でその操作にかかった時間である workingMillis に基づいてログに記録されます。つまり、ロック待ちやフロー制御などの要因は、操作が低速操作のしきい値を超えるかどうかに影響しません。

低速操作のしきい値を変更するには、次のいずれかの方法で必要なしきい値を指定します。

• profile コマンドまたは db.setProfilingLevel() シェルヘルパー メソッドを使用して slowms の値を設定します。

• スタートアップ時にコマンドラインから --slowms の値を設定します。

• 構成ファイルで slowOpThresholdMs の値を設定します。

次の例では、現在接続されているデータベースのプロファイリング レベルを1 に設定し、mongod インスタンスにおける低速操作のしきい値を 20 ミリ秒に設定します。

db.setProfilingLevel( 1, { slowms: 20 } )

プロファイリング レベルが 1 の場合、プロファイラーは slowms のしきい値よりも遅い操作を記録します。

db.setProfilingLevel() を使用して、mongos の slowms と sampleRate を構成できます。mongos の場合、slowms および sampleRate の構成設定は診断ログにのみ影響し、プロファイラーには影響しません。プロファイリングは mongos では使用できないためです。[1]

次の例では、低速操作のログを 20 に記録するため、mongos インスタンスの低速操作のしきい値を設定します。

db.setProfilingLevel( 0, { slowms: 20 } )

プロファイラー エントリと読み取り操作および書込み (write ) 操作の 診断ログ メッセージ（mongod/mongos ログ メッセージなど）には次のものが含まれます。

• planCacheShapeHash プランキャッシュクエリシェイプが同じスロークエリを特定するのに役立ちます。

  MongoDB 8.0以降、既存のqueryHashフィールドの名前がplanCacheShapeHashに変更されます。 以前のバージョンの MongoDB を使用している場合は、 planCacheShapeHashではなくqueryHashが表示されます。

• planCacheKey 低速クエリのクエリプラン キャッシュに関する詳細なインサイトを提供します。

replica setのセカンダリ メンバーは、適用に低速操作しきい値よりも長い時間がかかるoplogをログに記録するようになりました。 これらの遅い oplog メッセージ:

• diagnostic logのセカンダリに対してログに記録されます。

• ログは、テキストapplied op: <oplog entry> took <num>msを含むREPLコンポーネントの下にあります。

• ログレベルに依存しない（システムレベルでもコンポーネントレベルでも）

• プロファイル レベルに依存しないでください。

• slowOpSampleRateの影響を受けます。

プロファイラーは遅い oplog エントリをキャプチャしません。

低速操作のランダム サンプルのプロファイリング

すべての低速操作からランダムにサンプリングされたサブセットのみをプロファイリングするには、次のいずれかの方法で、必要なサンプリング レートを指定します。 [2]

• profile コマンドまたは db.setProfilingLevel() シェルヘルパー メソッドを使用して sampleRate の値を設定します。

• スタートアップ時にコマンドラインから mongod の場合は --slowOpSampleRate の値、mongos の場合は --slowOpSampleRate の値を設定します。

• 構成ファイルで slowOpSampleRate の値を設定します。

デフォルトでは、sampleRate は 1.0 に設定されています。つまり、すべての低速操作がプロファイリングされます。sampleRate が 0 と 1 の間に設定されている場合、プロファイリング レベルが 1 のデータベースは、sampleRate に基づいてランダムにサンプリングされた割合で低速操作をプロファイリングします。

次の例では、現在接続されているデータベースのプロファイリング レベルを 1 に設定し、プロファイラーがすべての低速操作の 42% をサンプリングするように設定します。

db.setProfilingLevel( 1, { sampleRate: 0.42 } )

変更されたサンプル レート値はシステム ログにも適用されます。

db.setProfilingLevel() を使用して、mongos の slowms と sampleRate を構成できます。mongos の場合、slowms および sampleRate の構成設定は診断ログにのみ影響し、プロファイラーには影響しません。プロファイリングは mongos では使用できないためです。[1]

次の例では、低速操作をログに記録するための mongos インスタンスのサンプリング レートを設定します。

db.setProfilingLevel( 0, { sampleRate: 0.42 } )

プロファイルされた操作を決定するためにフィルターを設定する

どの操作をプロファイリングしてログに記録するかは、フィルターの設定で制御できます。プロファイリング フィルターは、次のいずれかの方法で設定できます。

• profile コマンドまたは db.setProfilingLevel() シェルヘルパー メソッドを使用して filter の値を設定します。

• 構成ファイルで filter の値を設定します。

mongod インスタンスの場合、filter は診断ログと（有効になっている場合）プロファイラーの両方に影響します。

mongos インスタンスの場合、filter は診断ログにのみ影響し、プロファイラーには影響しません。プロファイリングは mongosでは使用できないためです。

次の db.setProfilingLevel() の例では、現在接続されているデータベースのプロファイリング レベルを設定します。

• プロファイリングレベル を 2 に設定し、

• { op: "query", millis: { $gt: 2000 } } のフィルター をかけると、プロファイラーは 2 秒以上かかったquery 操作のみをログに記録します。

db.setProfilingLevel( 2, { filter: { op: "query", millis: { $gt: 2000 } } } )

プロファイリング レベルの確認

プロファイリング レベルを表示するには、 mongoshで次の例を実行します。

db.getProfilingStatus()

shellは、次のようなドキュメントを返します。

{ "was" : 0, "slowms" : 100, "sampleRate" : 1.0, "ok" : 1 }

was フィールドは、現在のプロファイリング レベルを示します。

slowms フィールドは、低速とみなされる操作時間のしきい値（ミリ秒単位）を示します。

sampleRate フィールドは、プロファイリングするべき低速操作の割合を示します。

プロファイリングの無効化

プロファイリングを無効にするには、mongosh で次の例を実行します。

db.setProfilingLevel(0)

mongod インスタンス全体のプロファイリングを有効にする

開発環境およびテスト環境では、mongod インスタンス全体に対してデータベースのプロファイリングを有効にできます。プロファイリング レベルは、mongod インスタンスのすべてのデータベースに適用されます。

mongod インスタンスのプロファイリングを有効にするには、スタートアップ時に次のオプションを mongod に渡します。

mongod --profile 1 --slowms 15 --slowOpSampleRate 0.5

または、構成ファイルで operationProfiling を指定します。

これにより、プロファイリング レベルが 1 に設定され、15 ミリ秒より長く続く操作が低速と定義され、低速操作の 50% のみをプロファイリングするように指定されます。[2]

slowms と slowOpSampleRate は、logLevel が 0 に設定されている場合に診断ログに記録される操作にも影響します。slowms と slowOpSampleRate は、mongos の診断ログの構成にも使用できます。[2]

データベース プロファイリングとシャーディング

mongos インスタンスではプロファイリングを有効にできません。シャーディングされたクラスターでプロファイリングを有効にするには、クラスター内の各 mongod インスタンスのプロファイリングを有効にする必要があります。

ただし、--slowms と slowOpSampleRate を mongos で設定すると、低速操作の診断ログを構成できます。

プロファイラーのデータ クエリの例

このセクションでは、system.profile コレクションのクエリの例を示します。クエリ出力の詳細については、「データベースプロファイラー出力」を参照してください。

system.profile コレクション内の直近 10 件のログ エントリを返すには、次のようなクエリを実行します。

db.system.profile.find().limit(10).sort( { ts : -1 } ).pretty()

コマンド操作（$cmd）を除くすべての操作を返すには、次のようなクエリを実行します。

db.system.profile.find( { op: { $ne : 'command' } } ).pretty()

特定のコレクションの操作を返すには、次のようなクエリを実行します。この例では、 mydb データベースの test コレクションの操作を返します。

db.system.profile.find( { ns : 'mydb.test' } ).pretty()

完了までの時間が 5 ミリ秒を超える操作を返すには、次を実行します。

db.system.profile.find( { millis : { $gt : 5 } } ).pretty()

特定の時間範囲の操作を返すには、次を実行します。

db.system.profile.find( {
   ts : {
      $gt: new ISODate("2012-12-09T03:00:00Z"),
      $lt: new ISODate("2012-12-09T03:40:00Z")
   }
} ).pretty()

次の例では、時間範囲を確認し、読みやすくするために出力の user フィールドを非表示にして、各操作の実行時間で結果を並べ替えます。

db.system.profile.find( {
   ts : {
      $gt: new ISODate("2011-07-12T03:00:00Z"),
      $lt: new ISODate("2011-07-12T03:40:00Z")
   }
}, { user: 0 } ).sort( { millis: -1 } )

最新の 5 つのイベントを表示する

プロファイリングが有効になっているデータベースでは、 mongoshのshow profileヘルパーには、実行に少なくとも1ミリ秒かかった5の最新の操作が表示されます。 mongosh show profileを実行します。

show profile

system.profile コレクション

system.profile コレクションは、デフォルト サイズが 1 メガバイトの上限付きコレクションです。このサイズのコレクションには通常、数千のプロファイル ドキュメントを格納できますが、アプリケーションによって、1 回の操作で使用するプロファイリング データの量は増減する場合があります。system.profile コレクションのサイズを変更する必要がある場合、以下の手順に従ってください。

プライマリの system.profile コレクションのサイズ変更

プライマリの system.profile コレクションのサイズを変更する手順は以下の通りです。

1. プロファイリングを無効にします。

2. system.profile コレクションを削除します。

3. 新しいsystem.profile コレクションを作成します。

4. プロファイリングを再度有効にします。

たとえば、 4000000バイト（ 4 MB）の新しいsystem.profileコレクションを作成するには、 mongoshで次の一連の操作を使用します。

db.setProfilingLevel(0)
db.system.profile.drop()
db.createCollection( "system.profile", { capped: true, size:4000000 } )
db.setProfilingLevel(1)

セカンダリの system.profile コレクションのサイズ変更

セカンダリ 上のsystem.profileコレクションのサイズを変更するには、セカンダリを停止してスタンドアロンとして実行してから、上記の手順を踏む必要があります。 完了したら、そのスタンドアロンをレプリカセットのノードとして再起動します。 詳細は、「自己管理型レプリカセットのノードのメンテナンスの実行 」を参照してください。