db.serverStatus()
db.serverStatus()
データベース プロセスの状態の概要を示すドキュメントを返します。
このコマンドは、データベース コマンド
serverStatus
にラッパーを提供します。
互換性
このメソッドは、次の環境でホストされている配置で使用できます。
MongoDB Atlas はクラウドでの MongoDB 配置のためのフルマネージド サービスです
注意
このコマンドは、すべての MongoDB Atlas クラスターでサポートされています。すべてのコマンドに対する Atlas のサポートについては、 「サポートされていないコマンド」を参照してください。
MongoDB Enterprise: サブスクリプションベースの自己管理型 MongoDB バージョン
MongoDB Community: ソースが利用可能で、無料で使用できる自己管理型の MongoDB のバージョン
動作
デフォルトでは、db.serverStatus()
出力から以下が除外されます:
repl ドキュメント内の一部のコンテンツ
mirroredReads ドキュメント。
デフォルトで除外されるフィールドを含めるには、最上位フィールドを指定し、コマンドで 1
に設定します。デフォルトで含まれるフィールドを除外するには、フィールドを指定して 0 に設定します。最上位フィールドまたは埋め込みフィールドのいずれかを指定できます。
たとえば、次の操作は、出力内の repl
、metrics
、および locks
情報を抑制します。
db.serverStatus( { repl: 0, metrics: 0, locks: 0 } )
次の例では、出力にすべての repl 情報が含まれます。
db.serverStatus( { repl: 1 } )
初期化
db.serverStatus()
によって報告された統計は、 mongod
サーバーを再起動するとリセットされます。 db.serverStatus()
コマンドは、サーバー イベントによって初期化されるまで、いくつかの統計情報を報告しません。
たとえば、 mongod
サーバーを再起動すると、 db.serverStatus()
はfindAndModify
の値を返しません。
db.serverStatus().metrics.commands.findAndModify // No results returned
アップデート クエリを実行すると、 db.serverStatus()
に対する後続の呼び出しに期待されるメトリクスが表示されます。
{ "arrayFilters" : NumberLong(0), "failed" : NumberLong(0), "pipeline" : NumberLong(0), "total" : NumberLong(1) }
注意
カウンターの増加が始まる前に特定のオブジェクトが照会された場合、db.serverStatus()
メソッドはエラーを返します。
ドキュメントの更新がまだない場合:
db.serverStatus().metrics.commands.update.pipeline
次の値を返します。
TypeError: db.serverStatus(...).metrics.commands.update is undefined : @(shell):1:1
次を含みます: mirroredReads
デフォルトでは、 mirroredReads
情報は出力に含まれていません。 mirroredReads
情報を返すには、包含を明示的に指定する必要があります。
db.serverStatus( { mirroredReads: 1 } )
出力
この関数の出力の完全なドキュメントについては、「serverStatus 出力」を参照してください。