Monitoramento

Eventos de comando

Um evento de comando é um evento relacionado a um comando do banco de dados MongoDB. Alguns exemplos de comandos do banco de dados que produzem eventos de comando são find, insert, delete e count.

Para monitorar eventos de comando, escreva uma classe que implemente a interface do CommandListener e registre uma instância dessa classe com sua instância do MongoClient.

Para saber mais sobre os comandos do banco de dados MongoDB, consulte o guia Comandos do banco de dados no Manual do 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 descoberta e monitoramento de servidores

Um evento de descoberta e monitoramento de servidor (SDAM) é um evento relacionado a uma alteração no estado da instância MongoDB ou cluster ao qual você conectou o driver.

O driver define nove eventos SDAM. O driver divide esses nove eventos entre três interfaces de ouvinte separadas. Veja a seguir as três interfaces e os eventos que elas escutam:

• ClusterListener: eventos relacionados à topologia

• ServerListener: eventos relacionados a processos mongod ou mongos

• ServerMonitorListener: eventos relacionados ao batimento cardíaco

Para monitorar um tipo de evento SDAM, escreva uma classe que implemente uma das três interfaces anteriores e registre uma instância dessa classe com sua instância MongoClient.

Para obter uma descrição detalhada de cada evento SDAM no driver, consulte a seção API do servidor da Especificação de Monitoramento e Registro SDAM do MongoDB no 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 do pool de conexões

Um evento do pool de conexões é um evento relacionado a um pool de conexões mantido pelo driver. Um pool de conexões é um conjunto de conexões TCP abertas que seu driver mantém com uma instância MongoDB. Os pools de conexão ajudam a reduzir o número de handshakes de rede que seu aplicação precisa realizar com uma instância do MongoDB e podem ajudar seu aplicação a ser executado mais rapidamente. Para saber mais sobre pool de conexões, consulte o guia Pools de conexões do driver Java.

Para monitorar eventos do pool de conexões, escreva uma classe que implemente a interface ConnectionPoolListener e registre uma instância dessa classe com sua instância 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...

Suporte a JMX

Para habilitar o monitoramento do pool de conexões JMX, adicione uma instância da classe JMXConnectionPoolListener ao seu objeto MongoClient.

A classe JMXConnectionPoolListener executa as seguintes ações:

1. Cria instâncias de MXBean para cada processo do mongod ou mongos com o qual o driver mantém um pool de conexão.

2. Registra estas instâncias MXBean com o servidor MBean da plataforma.

Os MXBeans registrados no servidor MBean da plataforma têm as seguintes propriedades:

Todas as instâncias MXBean criadas pelo driver estão sob o domínio "org.mongodb.driver".

Para saber mais sobre os tópicos discutidos nesta subseção, consulte os seguintes recursos da Oracle:

• Documentação de Referência do Servidor MBean da Plataforma

• Documentação de MXBean

• Documentação do MBean

Exemplo de JMX e JConsole

Este exemplo mostra como você pode monitorar os pools de conexão do driver usando JMX e JConsole. JConsole é uma ferramenta de monitoramento de GUI compatível com JMX que vem com a Java Platform.

O seguinte trecho de código adiciona um JMXConnectionPoolListener a uma instância do MongoClient. O código então pausa a execução para que você possa navegar até o JConsole e inspecionar seus pools de conexão:

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

O trecho de código anterior produz um resultado semelhante ao seguinte:

Navigate to JConsole to see your connection pools...

Após iniciar seu servidor, abra o JConsole em seu terminal utilizando o seguinte comando:

jconsole

Quando o JConsole estiver aberto, realize as seguintes ações na interface do usuário:

1. Selecione o processo Java que executa o código de exemplo anterior.

2. Pressione Insecure Connection na caixa de diálogo de aviso.

3. Clique na aba MBeans.

4. Inspecione os eventos do pool de conexões no domínio "org.mongodb.driver".

Quando você não quiser mais inspecionar seus pools de conexão no JConsole, faça o seguinte:

• Sair do JConsole fechando a janela do JConsole

• Pare o programa Java executando o trecho de código anterior

Para saber mais sobre JMX e JConsole, consulte os seguintes recursos da Oracle:

• Documentação do JConsole.

• Guia de monitoramento e gerenciamento

Para saber mais sobre a classe JMXConnectionPoolListener, consulte a documentação da API para JMXConnectionPoolListener.