Supervisar su implementación

Eventos de comando

Un evento de comando es un evento relacionado con un comando de base de datos MongoDB. Algunos ejemplos de comandos de base de datos que producen eventos de comando son find, insert, delete y count.

Para supervisar los eventos de comando, crea una clase que implemente la interfaz CommandListener y registra una instancia de esa clase en tu instancia de MongoClient.

Para obtener más información sobre los comandos de base de datos de MongoDB, consulta Comandos de Base de Datos en el manual de MongoDB Server.

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();
}

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

Eventos de Descubrimiento y Supervisión de Servidores

Un evento de descubrimiento y monitoreo de servidor (SDAM) es un evento relacionado con un cambio en el estado de la instancia o el clúster de MongoDB al que ha conectado el controlador.

El driver define nueve eventos SDAM. El controlador divide estos nueve eventos entre tres interfaces diferentes de escucha, cada una de las cuales escucha tres de los nueve eventos. Aquí están las tres Interfaces y los eventos a los que escuchan:

• ClusterListener: eventos relacionados con latopología

• ServerListenereventos relacionados con mongod o mongos procesos

• ServerMonitorListener: eventos relacionados con la señal "latido"

Para supervisar un tipo de evento SDAM, guarda una clase que implemente una de las tres interfaces anteriores y registra una instancia de esa clase con tu instancia de MongoClient.

Para obtener una descripción detallada de cada evento SDAM en el controlador, consulte la Especificación de registro y monitoreo SDAM de MongoDB.

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();
}

Able to write to server

Eventos del grupo de conexiones

Un evento del pool de conexiones es un evento relacionado con un pool de conexiones mantenido por el driver. Un pool de conexiones es un conjunto de conexiones TCP abiertas que su driver mantiene con una implementación de MongoDB. Los grupos de conexiones ayudan a reducir la cantidad de handshakes de red que tu aplicación necesita realizar con una implementación de MongoDB y pueden ayudar a que tu aplicación funcione más rápido.

Para supervisar los eventos del pool de conexiones, escribe una clase que implemente la interfaz ConnectionPoolListener y registra una instancia de esa clase con tu instancia 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();
}

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

Soporte JMX

Para habilitar la supervisión del pool de conexiones JMX, agrega una instancia de la clase JMXConnectionPoolListener a tu objeto MongoClient.

La clase JMXConnectionPoolListener realiza las siguientes acciones:

1. Crea instancias de MXBean para cada proceso mongod o mongos con el que el driver mantiene un pool de conexiones

2. Registra estas instancias de MXBean en el servidor MBean de la plataforma

Los MXBeans registrados en el servidor MBean de la plataforma tienen las siguientes propiedades:

Todas las instancias de MXBean creadas por el driver están bajo el dominio "org.mongodb.driver".

Para obtener más información sobre los temas tratados en esta subsección, consulte los siguientes recursos de Oracle:

• Documentación de referencia del servidor de la plataforma MBean

• Documentación de MXBean

• Documentación de MBean

Ejemplo de JMX y JConsole

El siguiente ejemplo muestra cómo puedes supervisar los pools de conexiones del driver utilizando JMX y JConsole. JConsole es una herramienta de supervisión GUI compatible con JMX que se incluye con la Plataforma Java.

El siguiente fragmento de código añade una instancia JMXConnectionPoolListener a una instancia MongoClient. El código pausa la ejecución para que puedas acceder a JConsole e inspeccionar tus grupos de conexiones.

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);
}

Navigate to JConsole to see your connection pools...

Una vez que haya iniciado su servidor, abra JConsole ejecutando el siguiente comando en su terminal:

jconsole

Una vez abierto JConsole, realice las siguientes acciones en la GUI:

1. Seleccione el proceso Java que ejecuta el código de ejemplo anterior.

2. Haga clic Insecure Connection en el cuadro de diálogo de advertencia.

3. Haz clic en la pestaña MBeans.

4. Inspeccione los eventos de su grupo de conexiones bajo el dominio "org.mongodb.driver".

Cuando ya no desee inspeccionar sus grupos de conexiones en JConsole, realice las siguientes tareas:

1. Salga de JConsole cerrando la ventana de JConsole.

2. Detén el programa Java que ejecuta el anterior snippet.

Para obtener más información sobre JMX y JConsole, consulta los siguientes recursos de Oracle:

• Documentación de JConsole

• Guía de Supervisión y Gestión

Para obtener más información acerca de la clase JMXConnectionPoolListener, consulta la documentación de la API de JMXConnectionPoolListener.