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 monitorear eventos de comando, cree una clase que implemente la interfaz CommandListener y registre una instancia de esa clase con su instancia MongoClient.

Para obtener más información sobre los comandos de base de datos MongoDB,consulte Comandos de base de datos en el manual del servidor 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();
}

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

Eventos de detección y supervisión del servidor

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 controlador define nueve eventos SDAM. El controlador divide estos nueve eventos entre tres interfaces de escucha independientes, cada una de las cuales escucha tres de los nueve eventos. A continuación, se muestran las tres interfaces y los eventos que escuchan:

• ClusterListener: eventos relacionados con latopología

• ServerListener: eventos relacionados con mongod o mongos procesos

• ServerMonitorListener:eventos relacionados con los latidos del corazón

Para monitorear un tipo de evento SDAM, escriba una clase que implemente una de las tres interfaces anteriores y registre una instancia de esa clase con su instancia 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 de grupo de conexiones es un evento relacionado con un grupo de conexiones que mantiene el controlador. Un grupo de conexiones es un conjunto de conexiones TCP abiertas que su controlador mantiene con una implementación de MongoDB. Los grupos de conexiones ayudan a reducir el número de protocolos de enlace de red que su aplicación debe realizar con una implementación de MongoDB y pueden acelerar su ejecución.

Para monitorear eventos del grupo de conexiones, escriba una clase que implemente la interfaz ConnectionPoolListener y registre una instancia de esa clase con su 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 grupo de conexiones JMX, agregue una instancia de la clase JMXConnectionPoolListener a su 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 MXBean creadas por el controlador 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 supervisar los grupos de conexiones del controlador mediante JMX y JConsole. JConsole es una herramienta de monitorización de interfaz gráfica de usuario (GUI) compatible con JMX que se incluye en 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. Haga 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. Detenga el programa Java que ejecuta el fragmento de código anterior.

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

• Documentación de JConsole

• Guía de Monitoreo y Gestión

Para obtener más información sobre la JMXConnectionPoolListener clase, consulte la documentación de API para JMXConnectionPoolListener.