Monitoring

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 eventos de comandos, guardar una clase que implemente la interfaz CommandListener y registra una instancia de esa clase en tu instancia MongoClient.

Para obtener más información sobre los comandos de base de datos de MongoDB, consulta la guía Database Commands en el Manual del Servidor.

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

MongoClientSettings settings =
        MongoClientSettings.builder()
                .applyConnectionString(URI)
                .addCommandListener(new CommandCounter())
                .build();
MongoClient mongoClient = MongoClients.create(settings);
MongoDatabase database = mongoClient.getDatabase(DATABASE);
MongoCollection<Document> collection = database.getCollection(COLLECTION);
// Runs sample find() commands to test the timer
collection.find().first();
collection.find().first();
mongoClient.close();

{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 de escucha separadas. Las siguientes son las tres interfaces y los eventos a los que están atentos:

• ClusterListenerEventos relacionados a topología

• ServerListenereventos relacionados con mongod o mongos procesos

• ServerMonitorListener: eventos relacionados con el latido cardíaco

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 driver, consulta la sección API del servidor de la Especificación de supervisión y registro de SDAM de MongoDB en GitHub.

class IsWriteable 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");
            }
        }
    }
}

IsWriteable clusterListener = new IsWriteable();
MongoClientSettings settings =
        MongoClientSettings.builder()
                .applyConnectionString(URI)
                .applyToClusterSettings(builder ->
                        builder.addClusterListener(clusterListener))
                .build();
MongoClient mongoClient = MongoClients.create(settings);
MongoDatabase database = mongoClient.getDatabase(DATABASE);
MongoCollection<Document> collection = database.getCollection(COLLECTION);
// Runs a sample find() command to trigger a ClusterDescriptionChangedEvent event
collection.find().first();

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 tu controlador mantiene con una instancia de MongoDB. Las agrupaciones de conexiones ayudan a reducir el número de handshakes de red que tu aplicación necesita realizar con una instancia de MongoDB y pueden ayudar a que tu aplicación se ejecute más rápido. Para obtener más información sobre los pools de conexiones, consulte la guía del driver de Java Pools de conexiones.

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.println(String.format("Let me get you the connection with id %s...",
                event.getConnectionId().getLocalValue()));
    }
    @Override
    public void connectionCheckOutFailed(final ConnectionCheckOutFailedEvent event) {
        System.out.println("Something went wrong! Failed to checkout connection.");
    }
}

ConnectionPoolLibrarian cpListener = new ConnectionPoolLibrarian();
MongoClientSettings settings =
        MongoClientSettings.builder()
                .applyConnectionString(URI)
                .applyToConnectionPoolSettings(builder ->
                        builder.addConnectionPoolListener(cpListener))
                .build();
MongoClient mongoClient = MongoClients.create(settings);
MongoDatabase database = mongoClient.getDatabase(DATABASE);
MongoCollection<Document> collection = database.getCollection(COLLECTION);
// Runs a sample find() command to trigger connection pool events
collection.find().first();

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 MXBean con 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 más información sobre los temas discutidos en esta subsección, consulte los siguientes recursos de Oracle:

• Documentación de referencia de Platform MBean Server

• documentación de MXBean

• Documentación de MBean

Ejemplo de JMX y JConsole

Este 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 snippet añade un JMXConnectionPoolListener a una instancia de MongoClient. El código luego pausa la ejecución para que puedas navegar a JConsole e inspeccionar los grupos de conexiones:

JMXConnectionPoolListener connectionPoolListener = new JMXConnectionPoolListener();
MongoClientSettings settings =
        MongoClientSettings.builder()
                .applyConnectionString(URI)
                .applyToConnectionPoolSettings(builder -> builder.addConnectionPoolListener(connectionPoolListener))
                .build();
// Creates a MongoClient instance that enables connection pool event monitoring with the JMX tool
MongoClient mongoClient = MongoClients.create(settings);
try {
    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);
// Prints exception details if any exceptions occur during the code execution
} catch (Exception e) {
    e.printStackTrace();
}

El snippet de código anterior produce una salida similar a la siguiente:

Navigate to JConsole to see your connection pools...

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

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. Presiona 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, haga lo siguiente:

• Salga de JConsole cerrando la ventana de JConsole

• Detén el programa Java que ejecuta el fragmento de código precedente

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 sobre la JMXConnectionPoolListener clase, consulte la documentación de API para JMXConnectionPoolListener.