配置のモニタリング

コマンド イベント

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

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

MongoDB database コマンドの詳細については、MongoDB サーバー マニュアルの「データベースコマンド」を参照してください。

class CommandCounter implements CommandListener {
    private final Map<String, Integer> commands = new HashMap<String, Integer>();
    @Override
    public synchronized void commandSucceeded(final CommandSucceededEvent event) {
        String commandName = event.getCommandName();
        int count = commands.getOrDefault(commandName, 0);
        commands.put(commandName, count + 1);
        System.out.println(commands);
    }
    @Override
    public void commandFailed(final CommandFailedEvent event) {
        System.out.printf("Failed execution of command '%s' with id %s%n",
                event.getCommandName(),
                event.getRequestId());
    }
}

MongoClientSettings settings = MongoClientSettings.builder()
        .applyConnectionString(URI)
        .addCommandListener(new CommandCounter())
        .build();
try (MongoClient mongoClient = MongoClients.create(settings)) {
    MongoDatabase database = mongoClient.getDatabase(DATABASE);
    MongoCollection<Document> collection = database.getCollection(COLLECTION);
    // Run some commands to test the counter
    FindPublisher<Document> findPublisher1 = collection.find();
    FindPublisher<Document> findPublisher2 = collection.find();
    Flux.from(findPublisher1).blockLast();
    Flux.from(findPublisher2).blockLast();
}

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

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

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

• ClusterListener: topology-related events

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

• ServerMonitorListener: heartbeat-related events

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

ドライバー内の各 SDAM イベントの詳細については、「 MongoDB SDAM ログ記録とモニタリングの仕様 」を参照してください。

class IsWritable implements ClusterListener {
    private boolean isWritable;
    @Override
    public synchronized void clusterDescriptionChanged(final ClusterDescriptionChangedEvent event) {
        if (!isWritable) {
            if (event.getNewDescription().hasWritableServer()) {
                isWritable = true;
                System.out.println("Able to write to server");
            }
        } else if (!event.getNewDescription().hasWritableServer()) {
            isWritable = false;
            System.out.println("Unable to write to server");
        }
    }
}

MongoClientSettings settings = MongoClientSettings.builder()
        .applyConnectionString(URI)
        .applyToClusterSettings(builder ->
                builder.addClusterListener(new IsWritable()))
        .build();
try (MongoClient mongoClient = MongoClients.create(settings)) {
    MongoDatabase database = mongoClient.getDatabase(DATABASE);
    MongoCollection<Document> collection = database.getCollection(COLLECTION);
    // Run a command to trigger a ClusterDescriptionChangedEvent
    FindPublisher<Document> findPublisher = collection.find();
    Flux.from(findPublisher).blockLast();
}

接続プール イベント

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

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

class ConnectionPoolLibrarian implements ConnectionPoolListener {
    @Override
    public void connectionCheckedOut(final ConnectionCheckedOutEvent event) {
        System.out.printf("Fetching the connection with id %s...%n",
                event.getConnectionId().getLocalValue());
    }
    @Override
    public void connectionCheckOutFailed(final ConnectionCheckOutFailedEvent event) {
        System.out.println("Something went wrong! Failed to checkout connection.");
    }
}

MongoClientSettings settings = MongoClientSettings.builder()
        .applyConnectionString(URI)
        .applyToClusterSettings(builder ->
                builder.addClusterListener(new IsWritable()))
        .build();
try (MongoClient mongoClient = MongoClients.create(settings)) {
    MongoDatabase database = mongoClient.getDatabase(DATABASE);
    MongoCollection<Document> collection = database.getCollection(COLLECTION);
    // Run a command to trigger a ClusterDescriptionChangedEvent
    FindPublisher<Document> findPublisher = collection.find();
    Flux.from(findPublisher).blockLast();
}

JTX サポート

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

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

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

2. これらの 排除します :

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

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

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

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

• macOS のドキュメント

• MBI ドキュメント

JMAX と Jコンソールの例

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

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

JMXConnectionPoolListener connectionPoolListener = new JMXConnectionPoolListener();
try (MongoClient mongoClient = MongoClients.create(URI)) {
    System.out.println("Navigate to JConsole to see your connection pools...");
    // Pauses the code execution so you can navigate to JConsole and inspect your connection pools
    Thread.sleep(Long.MAX_VALUE);
}

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

jconsole

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

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

2. Click Insecure Connection in the warning dialog box.

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

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

JCondle で接続プールを検査する必要がなくなった場合は、次のタスクを実行します。

1. JCon Console ウィンドウを閉じて、JConole を終了します。

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

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

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

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

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