Tools to monitor driver events.
Use register() to register global listeners for specific events. Currently only command events are published. Listeners must be a subclass of CommandListener and implement started(), succeeded(), and failed().
For example, a simple command logger might be implemented like this:
import logging
from pymongo import monitoring
class CommandLogger(monitoring.CommandListener):
def started(self, event):
logging.info("Command {0.command_name} with request id "
"{0.request_id} started on server "
"{0.connection_id}".format(event))
def succeeded(self, event):
logging.info("Command {0.command_name} with request id "
"{0.request_id} on server {0.connection_id} "
"succeeded in {0.duration_micros} "
"microseconds".format(event))
def failed(self, event):
logging.info("Command {0.command_name} with request id "
"{0.request_id} on server {0.connection_id} "
"failed in {0.duration_micros} "
"microseconds".format(event))
monitoring.register(CommandLogger())
Event listeners can also be registered per instance of MongoClient:
client = MongoClient(event_listeners=[CommandLogger()])
Note that previously registered global listeners are automatically included when configuring per client event listeners. Registering a new global listener will not add that listener to existing client instances.
Note
Events are delivered synchronously. Application threads block waiting for event handlers (e.g. started()) to return. Care must be taken to ensure that your event handlers are efficient enough to not adversely affect overall application performance.
Warning
The command documents published through this API are not copies. If you intend to modify them in any way you must copy them in your event handler first.
Register a global event listener.
Parameters : |
|
---|
Abstract base class for command listeners.
Abstract method to handle CommandFailedEvent.
Parameters : |
|
---|
Abstract method to handle CommandStartedEvent.
Parameters : |
|
---|
Abstract method to handle CommandSucceededEvent.
Parameters : |
|
---|
Event published when a command starts.
Parameters : |
|
---|
The command document.
The command name.
The address (host, port) of the server this command was sent to.
The name of the database this command was run against.
An id for this series of events or None.
The request id for this operation.
Event published when a command succeeds.
Parameters : |
|
---|
The command name.
The address (host, port) of the server this command was sent to.
The duration of this operation in microseconds.
An id for this series of events or None.
The server failure document for this operation.
The request id for this operation.
Event published when a command fails.
Parameters : |
|
---|
The command name.
The address (host, port) of the server this command was sent to.
The duration of this operation in microseconds.
The server failure document for this operation.
An id for this series of events or None.
The request id for this operation.