monitoring
– Tools for monitoring driver events.¶
Tools to monitor driver events.
Added in version 3.1.
Attention
Starting in PyMongo 3.11, the monitoring classes outlined below are included in the PyMongo distribution under the event_loggers
submodule.
See also
This module is compatible with both the synchronous and asynchronous PyMongo APIs.
Use register()
to register global listeners for specific events. Listeners must inherit from one of the abstract classes below and implement the correct functions for that class.
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())
Server discovery and monitoring events are also available. For example:
class ServerLogger(monitoring.ServerListener): def opened(self, event): logging.info("Server {0.server_address} added to topology " "{0.topology_id}".format(event)) def description_changed(self, event): previous_server_type = event.previous_description.server_type new_server_type = event.new_description.server_type if new_server_type != previous_server_type: # server_type_name was added in PyMongo 3.4 logging.info( "Server {0.server_address} changed type from " "{0.previous_description.server_type_name} to " "{0.new_description.server_type_name}".format(event)) def closed(self, event): logging.warning("Server {0.server_address} removed from topology " "{0.topology_id}".format(event)) class HeartbeatLogger(monitoring.ServerHeartbeatListener): def started(self, event): logging.info("Heartbeat sent to server " "{0.connection_id}".format(event)) def succeeded(self, event): # The reply.document attribute was added in PyMongo 3.4. logging.info("Heartbeat to server {0.connection_id} " "succeeded with reply " "{0.reply.document}".format(event)) def failed(self, event): logging.warning("Heartbeat to server {0.connection_id} " "failed with error {0.reply}".format(event)) class TopologyLogger(monitoring.TopologyListener): def opened(self, event): logging.info("Topology with id {0.topology_id} " "opened".format(event)) def description_changed(self, event): logging.info("Topology description updated for " "topology id {0.topology_id}".format(event)) previous_topology_type = event.previous_description.topology_type new_topology_type = event.new_description.topology_type if new_topology_type != previous_topology_type: # topology_type_name was added in PyMongo 3.4 logging.info( "Topology {0.topology_id} changed type from " "{0.previous_description.topology_type_name} to " "{0.new_description.topology_type_name}".format(event)) # The has_writable_server and has_readable_server methods # were added in PyMongo 3.4. if not event.new_description.has_writable_server(): logging.warning("No writable servers available.") if not event.new_description.has_readable_server(): logging.warning("No readable servers available.") def closed(self, event): logging.info("Topology with id {0.topology_id} " "closed".format(event))
Connection monitoring and pooling events are also available. For example:
class ConnectionPoolLogger(ConnectionPoolListener): def pool_created(self, event): logging.info("[pool {0.address}] pool created".format(event)) def pool_ready(self, event): logging.info("[pool {0.address}] pool is ready".format(event)) def pool_cleared(self, event): logging.info("[pool {0.address}] pool cleared".format(event)) def pool_closed(self, event): logging.info("[pool {0.address}] pool closed".format(event)) def connection_created(self, event): logging.info("[pool {0.address}][connection #{0.connection_id}] " "connection created".format(event)) def connection_ready(self, event): logging.info("[pool {0.address}][connection #{0.connection_id}] " "connection setup succeeded".format(event)) def connection_closed(self, event): logging.info("[pool {0.address}][connection #{0.connection_id}] " "connection closed, reason: " "{0.reason}".format(event)) def connection_check_out_started(self, event): logging.info("[pool {0.address}] connection check out " "started".format(event)) def connection_check_out_failed(self, event): logging.info("[pool {0.address}] connection check out " "failed, reason: {0.reason}".format(event)) def connection_checked_out(self, event): logging.info("[pool {0.address}][connection #{0.connection_id}] " "connection checked out of pool".format(event)) def connection_checked_in(self, event): logging.info("[pool {0.address}][connection #{0.connection_id}] " "connection checked into pool".format(event))
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.
listener (_EventListener) – A subclasses of CommandListener
, ServerHeartbeatListener
, ServerListener
, TopologyListener
, or ConnectionPoolListener
.
None
Abstract base class for command listeners.
Handles CommandStartedEvent, CommandSucceededEvent, and CommandFailedEvent.
Abstract method to handle a CommandFailedEvent.
event (CommandFailedEvent) – An instance of CommandFailedEvent
.
None
Abstract method to handle a CommandStartedEvent.
event (CommandStartedEvent) – An instance of CommandStartedEvent
.
None
Abstract method to handle a CommandSucceededEvent.
event (CommandSucceededEvent) – An instance of CommandSucceededEvent
.
None
Abstract base class for server listeners. Handles ServerOpeningEvent, ServerDescriptionChangedEvent, and ServerClosedEvent.
Added in version 3.3.
Abstract method to handle a ServerClosedEvent.
event (ServerClosedEvent) – An instance of ServerClosedEvent
.
None
Abstract method to handle a ServerDescriptionChangedEvent.
event (ServerDescriptionChangedEvent) – An instance of ServerDescriptionChangedEvent
.
None
Abstract method to handle a ServerOpeningEvent.
event (ServerOpeningEvent) – An instance of ServerOpeningEvent
.
None
Abstract base class for server heartbeat listeners.
Handles ServerHeartbeatStartedEvent, ServerHeartbeatSucceededEvent, and ServerHeartbeatFailedEvent.
Added in version 3.3.
Abstract method to handle a ServerHeartbeatFailedEvent.
event (ServerHeartbeatFailedEvent) – An instance of ServerHeartbeatFailedEvent
.
None
Abstract method to handle a ServerHeartbeatStartedEvent.
event (ServerHeartbeatStartedEvent) – An instance of ServerHeartbeatStartedEvent
.
None
Abstract method to handle a ServerHeartbeatSucceededEvent.
event (ServerHeartbeatSucceededEvent) – An instance of ServerHeartbeatSucceededEvent
.
None
Abstract base class for topology monitoring listeners. Handles TopologyOpenedEvent, TopologyDescriptionChangedEvent, and TopologyClosedEvent.
Added in version 3.3.
Abstract method to handle a TopologyClosedEvent.
event (TopologyClosedEvent) – An instance of TopologyClosedEvent
.
None
Abstract method to handle a TopologyDescriptionChangedEvent.
event (TopologyDescriptionChangedEvent) – An instance of TopologyDescriptionChangedEvent
.
None
Abstract method to handle a TopologyOpenedEvent.
event (TopologyOpenedEvent) – An instance of TopologyOpenedEvent
.
None
Abstract base class for connection pool listeners.
Handles all of the connection pool events defined in the Connection Monitoring and Pooling Specification: PoolCreatedEvent
, PoolClearedEvent
, PoolClosedEvent
, ConnectionCreatedEvent
, ConnectionReadyEvent
, ConnectionClosedEvent
, ConnectionCheckOutStartedEvent
, ConnectionCheckOutFailedEvent
, ConnectionCheckedOutEvent
, and ConnectionCheckedInEvent
.
Added in version 3.9.
Abstract method to handle a ConnectionCheckOutFailedEvent
.
Emitted when the driver’s attempt to check out a connection fails.
event (ConnectionCheckOutFailedEvent) – An instance of ConnectionCheckOutFailedEvent
.
None
Abstract method to handle a ConnectionCheckOutStartedEvent
.
Emitted when the driver starts attempting to check out a connection.
event (ConnectionCheckOutStartedEvent) – An instance of ConnectionCheckOutStartedEvent
.
None
Abstract method to handle a ConnectionCheckedInEvent
.
Emitted when the driver checks in a connection back to the connection Pool.
event (ConnectionCheckedInEvent) – An instance of ConnectionCheckedInEvent
.
None
Abstract method to handle a ConnectionCheckedOutEvent
.
Emitted when the driver successfully checks out a connection.
event (ConnectionCheckedOutEvent) – An instance of ConnectionCheckedOutEvent
.
None
Abstract method to handle a ConnectionClosedEvent
.
Emitted when a connection Pool closes a connection.
event (ConnectionClosedEvent) – An instance of ConnectionClosedEvent
.
None
Abstract method to handle a ConnectionCreatedEvent
.
Emitted when a connection Pool creates a Connection object.
event (ConnectionCreatedEvent) – An instance of ConnectionCreatedEvent
.
None
Abstract method to handle a ConnectionReadyEvent
.
Emitted when a connection has finished its setup, and is now ready to use.
event (ConnectionReadyEvent) – An instance of ConnectionReadyEvent
.
None
Abstract method to handle a PoolClearedEvent.
Emitted when a connection Pool is cleared.
event (PoolClearedEvent) – An instance of PoolClearedEvent
.
None
Abstract method to handle a PoolClosedEvent.
Emitted when a connection Pool is closed.
event (PoolClosedEvent) – An instance of PoolClosedEvent
.
None
Abstract method to handle a PoolCreatedEvent
.
Emitted when a connection Pool is created.
event (PoolCreatedEvent) – An instance of PoolCreatedEvent
.
None
Abstract method to handle a PoolReadyEvent
.
Emitted when a connection Pool is marked ready.
event (PoolReadyEvent) – An instance of PoolReadyEvent
.
None
Added in version 4.0.
Event published when a command starts.
command (_DocumentOut) – The command document.
database_name (str) – The name of the database this command was run against.
request_id (int) – The request id for this operation.
connection_id (_Address) – The address (host, port) of the server this command was sent to.
operation_id (Optional[int]) – An optional identifier for a series of related events.
service_id (Optional[ObjectId]) – The service_id this command was sent to, or None
.
server_connection_id (Optional[int])
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.
The server-side connection id for the connection this command was sent on, or None
.
Added in version 4.7.
The service_id this command was sent to, or None
.
Added in version 3.12.
Event published when a command succeeds.
duration (datetime.timedelta) – The command duration as a datetime.timedelta.
reply (_DocumentOut) – The server reply document.
command_name (str) – The command name.
request_id (int) – The request id for this operation.
connection_id (_Address) – The address (host, port) of the server this command was sent to.
operation_id (Optional[int]) – An optional identifier for a series of related events.
service_id (Optional[ObjectId]) – The service_id this command was sent to, or None
.
database_name (str) – The database this command was sent to, or ""
.
server_connection_id (Optional[int])
The command name.
The address (host, port) of the server this command was sent to.
The database_name this command was sent to, or ""
.
Added in version 4.6.
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.
The server-side connection id for the connection this command was sent on, or None
.
Added in version 4.7.
The service_id this command was sent to, or None
.
Added in version 3.12.
Event published when a command fails.
duration (datetime.timedelta) – The command duration as a datetime.timedelta.
failure (_DocumentOut) – The server reply document.
command_name (str) – The command name.
request_id (int) – The request id for this operation.
connection_id (_Address) – The address (host, port) of the server this command was sent to.
operation_id (Optional[int]) – An optional identifier for a series of related events.
service_id (Optional[ObjectId]) – The service_id this command was sent to, or None
.
database_name (str) – The database this command was sent to, or ""
.
server_connection_id (Optional[int])
The command name.
The address (host, port) of the server this command was sent to.
The database_name this command was sent to, or ""
.
Added in version 4.6.
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.
The server-side connection id for the connection this command was sent on, or None
.
Added in version 4.7.
The service_id this command was sent to, or None
.
Added in version 3.12.
Published when server description changes.
Added in version 3.3.
previous_description (ServerDescription)
new_description (ServerDescription)
args (Any)
The new ServerDescription
.
The previous ServerDescription
.
The address (host, port) pair of the server
A unique identifier for the topology this server is a part of.
Published when server is initialized.
Added in version 3.3.
server_address (_Address)
topology_id (ObjectId)
The address (host, port) pair of the server
A unique identifier for the topology this server is a part of.
Published when server is closed.
Added in version 3.3.
server_address (_Address)
topology_id (ObjectId)
The address (host, port) pair of the server
A unique identifier for the topology this server is a part of.
Published when the topology description changes.
Added in version 3.3.
previous_description (TopologyDescription)
new_description (TopologyDescription)
args (Any)
The new TopologyDescription
.
The previous TopologyDescription
.
A unique identifier for the topology this server is a part of.
Published when the topology is initialized.
Added in version 3.3.
topology_id (ObjectId)
A unique identifier for the topology this server is a part of.
Published when the topology is closed.
Added in version 3.3.
topology_id (ObjectId)
A unique identifier for the topology this server is a part of.
Published when a heartbeat is started.
Added in version 3.3.
connection_id (_Address)
awaited (bool)
Whether the heartbeat was issued as an awaitable hello command.
Added in version 4.6.
The address (host, port) of the server this heartbeat was sent to.
Fired when the server heartbeat succeeds.
Added in version 3.3.
Whether the heartbeat was awaited.
If true, then duration()
reflects the sum of the round trip time to the server and the time that the server waited before sending a response.
Added in version 3.11.
The address (host, port) of the server this heartbeat was sent to.
The duration of this heartbeat in microseconds.
An instance of Hello
.
Fired when the server heartbeat fails, either with an “ok: 0” or a socket exception.
Added in version 3.3.
Whether the heartbeat was awaited.
If true, then duration()
reflects the sum of the round trip time to the server and the time that the server waited before sending a response.
Added in version 3.11.
The address (host, port) of the server this heartbeat was sent to.
The duration of this heartbeat in microseconds.
A subclass of Exception
.
Published when a Connection Pool is created.
Added in version 3.9.
The address (host, port) pair of the server the pool is attempting to connect to.
Any non-default pool options that were set on this Connection Pool.
Published when a Connection Pool is cleared.
Added in version 3.9.
The address (host, port) pair of the server the pool is attempting to connect to.
If True, active connections are interrupted during clearing.
Added in version 4.7.
Connections with this service_id are cleared.
When service_id is None
, all connections in the pool are cleared.
Added in version 3.12.
Published when a Connection Pool is closed.
address (_Address) – The address (host, port) pair of the server this Pool is attempting to connect to.
Added in version 3.9.
The address (host, port) pair of the server the pool is attempting to connect to.
Published when a Connection Pool creates a Connection object.
NOTE: This connection is not ready for use until the ConnectionReadyEvent
is published.
address (_Address) – The address (host, port) pair of the server this Connection is attempting to connect to.
connection_id (int) – The integer ID of the Connection in this Pool.
Added in version 3.9.
The address (host, port) pair of the server this connection is attempting to connect to.
The ID of the connection.
Published when a Connection has finished its setup, and is ready to use.
Added in version 3.9.
The address (host, port) pair of the server this connection is attempting to connect to.
The ID of the connection.
The duration of the connection event.
Added in version 4.7.
An enum that defines values for reason on a ConnectionClosedEvent
.
Added in version 3.9.
The connection experienced an error, making it no longer valid.
The connection became stale by being idle for too long (maxIdleTimeMS).
The pool was closed, making the connection no longer valid.
The pool was cleared, making the connection no longer valid.
Published when a Connection is closed.
Added in version 3.9.
The address (host, port) pair of the server this connection is attempting to connect to.
The ID of the connection.
A reason explaining why this connection was closed.
The reason must be one of the strings from the ConnectionClosedReason
enum.
Published when the driver starts attempting to check out a connection.
address (_Address) – The address (host, port) pair of the server this Connection is attempting to connect to.
Added in version 3.9.
The address (host, port) pair of the server this connection is attempting to connect to.
An enum that defines values for reason on a ConnectionCheckOutFailedEvent
.
Added in version 3.9.
The connection check out attempt experienced an error while setting up a new connection.
The pool was previously closed, and cannot provide new connections.
The connection check out attempt exceeded the specified timeout.
Published when the driver’s attempt to check out a connection fails.
Added in version 3.9.
The address (host, port) pair of the server this connection is attempting to connect to.
The ID of the connection.
The duration of the connection event.
Added in version 4.7.
A reason explaining why connection check out failed.
The reason must be one of the strings from the ConnectionCheckOutFailedReason
enum.
Published when the driver successfully checks out a connection.
Added in version 3.9.
The address (host, port) pair of the server this connection is attempting to connect to.
The ID of the connection.
The duration of the connection event.
Added in version 4.7.
Published when the driver checks in a Connection into the Pool.
address (_Address) – The address (host, port) pair of the server this Connection is attempting to connect to.
connection_id (int) – The integer ID of the Connection in this Pool.
Added in version 3.9.
The address (host, port) pair of the server this connection is attempting to connect to.
The ID of the connection.
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4