モニタリング

コマンド イベント

コマンド イベントは、MongoDB database コマンドに関連するイベントです。 コマンド イベントを生成するデータベースコマンドの例には、 find 、 insert 、 delete 、 countなどがあります。

コマンド イベントを監視するには、 CommandListenerインターフェースを実装するクラスを記述し、そのクラスのインスタンスをMongoClientインスタンスに登録します。

MongoDB データベースコマンドの詳細については、 データベースコマンドに関する MongoDB マニュアルのエントリを参照してください。

class CommandCounter : CommandListener {
    private val commands = mutableMapOf<String, Int>()
    @Synchronized
    override fun commandSucceeded(event: CommandSucceededEvent) {
        val commandName = event.commandName
        val count = commands[commandName] ?: 0
        commands[commandName] = count + 1
        println(commands.toString())
    }
    override fun commandFailed(event: CommandFailedEvent) {
        println("Failed execution of command '${event.commandName}' with id ${event.requestId}")
    }
}

val commandCounter = CommandCounter()
val settings = MongoClientSettings.builder()
    .applyConnectionString(URI)
    .addCommandListener(commandCounter)
    .build()
val mongoClient = MongoClient.create(settings)
val database = mongoClient.getDatabase(DATABASE)
val collection = database.getCollection<Document>(COLLECTION)
// Run some commands to test the counter
collection.find().firstOrNull()
collection.find().firstOrNull()

{find=1}
{find=2}
{find=2, endSessions=1}

サーバー検出と監視イベント

サーバー検出と監視（SDAM）イベントは、ドライバーを接続した MongoDB インスタンスまたはクラスターの状態の変更に関連するイベントです。

ドライバーは 9 つの SDAM イベントを定義します。 ドライバーはこれら 9 つのイベントを 3 つの個別のリスナー インターフェースに分割し、それぞれが 9 つのイベントのうち 3 つをリッスンします。 以下は 3 つのインターフェースと、それらが listen するイベントです。

• ClusterListener: トポロジー関連のイベント

• ServerListener: mongodまたはmongosプロセスに関連するイベント

• ServerMonitorListener: ハートビート関連のイベント

SDAM イベントのタイプを監視するには、前述の 3 つのインターフェースのいずれかを実装するクラスを記述し、そのクラスのインスタンスをMongoClientインスタンスに登録します。

各 SDAM イベントの詳細については、「 MongoDB SDAM モニタリング イベントの仕様 」を参照してください。

class IsWriteable : ClusterListener {
    private var isWritable = false
    @Synchronized
    override fun clusterDescriptionChanged(event: ClusterDescriptionChangedEvent) {
        if (!isWritable) {
            if (event.newDescription.hasWritableServer()) {
                isWritable = true
                println("Able to write to cluster")
            }
        } else {
            if (!event.newDescription.hasWritableServer()) {
                isWritable = false
                println("Unable to write to cluster")
            }
        }
    }
}

val clusterListener = IsWriteable()
val settings = MongoClientSettings.builder()
    .applyConnectionString(URI)
    .applyToClusterSettings { builder ->
        builder.addClusterListener(clusterListener)
    }
    .build()
val mongoClient = MongoClient.create(settings)
val database = mongoClient.getDatabase(DATABASE)
val collection = database.getCollection<Document>(COLLECTION)
// Run a command to trigger a ClusterDescriptionChangedEvent event
collection.find().firstOrNull()

Able to write to server

接続プール イベント

接続プール イベントは、ドライバーによって保持される接続プールに関連するイベントです。 接続プールは、ドライバーが MongoDB インスタンスと維持するオープン TCP 接続のセットです。 接続プールは、アプリケーションが MongoDB インスタンスで実行する必要があるネットワーク ハンドシェイクの数を減らし、アプリケーションの実行を高速化するのに役立ちます。

接続プールのイベントを監視するには、 ConnectionPoolListenerインターフェースを実装するクラスを記述し、そのクラスのインスタンスをMongoClientインスタンスに登録します。

class ConnectionPoolLibrarian : ConnectionPoolListener {
    override fun connectionCheckedOut(event: ConnectionCheckedOutEvent) {
        println("Let me get you the connection with id ${event.connectionId.localValue}...")
    }
    override fun connectionCheckOutFailed(event: ConnectionCheckOutFailedEvent) {
        println("Something went wrong! Failed to checkout connection.")
    }
}

val cpListener = ConnectionPoolLibrarian()
val settings = MongoClientSettings.builder()
    .applyConnectionString(URI)
    .applyToConnectionPoolSettings { builder ->
        builder.addConnectionPoolListener(cpListener)
    }
    .build()
val mongoClient = MongoClient.create(settings)
val database = mongoClient.getDatabase(DATABASE)
val collection = database.getCollection<Document>(COLLECTION)
// Run a command to trigger connection pool events
collection.find().firstOrNull()

Let me get you the connection with id 21...

JTX サポート

JMAX 接続プールのモニタリングを有効にするには、 JMXConnectionPoolListenerクラスのインスタンスをMongoClientオブジェクトに追加します。

JMXConnectionPoolListenerクラスは、次のアクションを実行します。

1. ドライバーが接続プールを維持する各mongodまたはmongosプロセスに対して macOS インスタンスを作成します。

2. これらの XT インスタンスをプラットフォーム M Manager サーバーに登録します。

プラットフォーム MBuilder に登録された macOS には、次のプロパティがあります。

ドライバーによって作成されたすべての 排除は、ドメイン"org.mongodb.driver"の下にあります。

このサブセクションで説明するトピックの詳細については、 Oracle の次のリソースを参照してください。

• プラットフォーム M Manager サーバーのリファレンス ドキュメント

• macOS のドキュメント

• MBI ドキュメント

JMAX と Jコンソールの例

この例では、 JMAX とJCon Console を使用してドライバーの接続プールを監視する方法を示します。 JCon Console は、Java プラットフォームに付属する JTX 準拠の GUI 監視ツールです。

次のコード スニペットは、 JMXConnectionPoolListenerをMongoClientインスタンスに追加します。 その後、コードの実行が一時停止されるため、JCondle に移動して接続プールを調べることができます。

val connectionPoolListener = JMXConnectionPoolListener()
val settings = MongoClientSettings.builder()
    .applyConnectionString(uri)
    .applyToConnectionPoolSettings {
        it.addConnectionPoolListener(connectionPoolListener)
    }
    .build()
val mongoClient: MongoClient = MongoClient.create(settings)
try {
    println("Navigate to JConsole to see your connection pools...")
    Thread.sleep(Long.MAX_VALUE)
} catch (e: Exception) {
    e.printStackTrace()
}

Navigate to JConsole to see your connection pools...

サーバーを起動したら、次のコマンドを使用してターミナルで Jコンソールを開きます。

jconsole

JConole が開いたら、GUI で次のアクションを実行します。

1. 上記のサンプル コードを実行しているプロセスを選択します。

2. 警告ダイアログ ボックスで [ Insecure Connectionを押します。

3. [ MBeans ] タブをクリックします。

4. "org.mongodb.driver"ドメインの下の接続プール イベントを調べます。

JCon Console で接続プールを検査 しなくなった 場合は、次の操作を行います。

• JCon Console ウィンドウを閉じて JConole を終了します

• 上記のコード スニペットを実行しているプログラムを停止します

JTX と JCon Console の詳細については、 Oracle の次のリソースを参照してください。

• Jコンソールのドキュメント。

• モニタリングとマネジメント ガイド

JMXConnectionPoolListenerクラスの詳細については、 JMAXConnectionPoolLister の API ドキュメントを参照してください。