1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210
//! Contains the events and functionality for monitoring Server Discovery and Monitoring.
mod topology_description;
use std::time::Duration;
use serde::Deserialize;
use crate::{
bson::{oid::ObjectId, Document},
error::Error,
options::ServerAddress,
};
pub use crate::sdam::public::TopologyType;
pub use topology_description::TopologyDescription;
/// A description of the most up-to-date information known about a server. Further details can be
/// found in the [Server Discovery and Monitoring specification](https://github.com/mongodb/specifications/blob/master/source/server-discovery-and-monitoring/server-discovery-and-monitoring.rst).
pub type ServerDescription = crate::sdam::public::ServerInfo<'static>;
/// Published when a server description changes.
#[derive(Clone, Debug)]
#[non_exhaustive]
pub struct ServerDescriptionChangedEvent {
/// The address of the server.
pub address: ServerAddress,
/// The unique ID of the topology.
pub topology_id: ObjectId,
/// The server's previous description.
pub previous_description: ServerDescription,
/// The server's new description.
pub new_description: ServerDescription,
}
/// Published when a server is initialized.
#[derive(Clone, Debug, Deserialize, PartialEq)]
#[non_exhaustive]
pub struct ServerOpeningEvent {
/// The address of the server.
pub address: ServerAddress,
/// The unique ID of the topology.
#[serde(skip, default = "ObjectId::new")]
pub topology_id: ObjectId,
}
/// Published when a server is closed.
#[derive(Clone, Debug, Deserialize, PartialEq)]
#[non_exhaustive]
pub struct ServerClosedEvent {
/// The address of the server.
pub address: ServerAddress,
/// The unique ID of the topology.
#[serde(skip, default = "ObjectId::new")]
pub topology_id: ObjectId,
}
/// Published when a topology description changes.
#[derive(Clone, Debug)]
#[non_exhaustive]
pub struct TopologyDescriptionChangedEvent {
/// The ID of the topology.
pub topology_id: ObjectId,
/// The topology's previous description.
pub previous_description: TopologyDescription,
/// The topology's new description.
pub new_description: TopologyDescription,
}
/// Published when a topology is initialized.
#[derive(Clone, Debug, Deserialize)]
#[non_exhaustive]
pub struct TopologyOpeningEvent {
/// The unique ID of the topology.
#[serde(skip, default = "ObjectId::new")]
pub topology_id: ObjectId,
}
/// Published when a topology is closed. Note that this event will not be published until the client
/// associated with the topology is dropped.
#[derive(Clone, Debug, Deserialize)]
#[non_exhaustive]
pub struct TopologyClosedEvent {
/// The unique ID of the topology.
#[serde(skip, default = "ObjectId::new")]
pub topology_id: ObjectId,
}
/// Published when a server monitor's `hello` or legacy hello command is started.
#[derive(Clone, Debug, Deserialize)]
#[non_exhaustive]
pub struct ServerHeartbeatStartedEvent {
/// The address of the server.
pub server_address: ServerAddress,
// TODO RUST-560 add awaited field
}
/// Published when a server monitor's `hello` or legacy hello command succeeds.
#[derive(Clone, Debug)]
#[non_exhaustive]
pub struct ServerHeartbeatSucceededEvent {
/// The execution time of the event.
pub duration: Duration,
/// The reply to the `hello` or legacy hello command.
pub reply: Document,
/// The address of the server.
pub server_address: ServerAddress,
// TODO RUST-560 add awaited field
}
/// Published when a server monitor's `hello` or legacy hello command fails.
#[derive(Clone, Debug)]
#[non_exhaustive]
pub struct ServerHeartbeatFailedEvent {
/// The execution time of the event.
pub duration: Duration,
/// The failure that occurred.
pub failure: Error,
/// The address of the server.
pub server_address: ServerAddress,
// TODO RUST-560 add awaited field
}
/// Applications can implement this trait to specify custom logic to run on each SDAM event sent
/// by the driver.
///
/// ```rust
/// # use std::sync::Arc;
/// #
/// # use mongodb::{
/// # error::Result,
/// # event::sdam::{
/// # SdamEventHandler,
/// # ServerHeartbeatFailedEvent,
/// # },
/// # options::ClientOptions,
/// # };
/// # #[cfg(feature = "sync")]
/// # use mongodb::sync::Client;
/// # #[cfg(not(feature = "sync"))]
/// # use mongodb::Client;
/// #
/// struct FailedHeartbeatLogger;
///
/// impl SdamEventHandler for FailedHeartbeatLogger {
/// fn handle_server_heartbeat_failed_event(&self, event: ServerHeartbeatFailedEvent) {
/// eprintln!("Failed server heartbeat: {:?}", event);
/// }
/// }
///
/// # fn do_stuff() -> Result<()> {
/// let handler: Arc<dyn SdamEventHandler> = Arc::new(FailedHeartbeatLogger);
/// let options = ClientOptions::builder()
/// .sdam_event_handler(handler)
/// .build();
/// let client = Client::with_options(options)?;
///
/// // Do things with the client, and failed server heartbeats will be logged to stderr.
/// # Ok(())
/// # }
/// ```
pub trait SdamEventHandler: Send + Sync {
/// A [`Client`](../../struct.Client.html) will call this method on each registered handler when
/// a server description changes.
fn handle_server_description_changed_event(&self, _event: ServerDescriptionChangedEvent) {}
/// A [`Client`](../../struct.Client.html) will call this method on each registered handler when
/// a server is initialized.
fn handle_server_opening_event(&self, _event: ServerOpeningEvent) {}
/// A [`Client`](../../struct.Client.html) will call this method on each registered handler when
/// a server is closed.
fn handle_server_closed_event(&self, _event: ServerClosedEvent) {}
/// A [`Client`](../../struct.Client.html) will call this method on each registered handler when
/// its topology description changes.
fn handle_topology_description_changed_event(&self, _event: TopologyDescriptionChangedEvent) {}
/// A [`Client`](../../struct.Client.html) will call this method on each registered handler when
/// its topology is initialized.
fn handle_topology_opening_event(&self, _event: TopologyOpeningEvent) {}
/// A [`Client`](../../struct.Client.html) will call this method on each registered handler when
/// its topology closes. Note that this method will not be called until the
/// [`Client`](../../struct.Client.html) is dropped.
fn handle_topology_closed_event(&self, _event: TopologyClosedEvent) {}
/// A [`Client`](../../struct.Client.html) will call this method on each registered handler when
/// a server heartbeat begins.
fn handle_server_heartbeat_started_event(&self, _event: ServerHeartbeatStartedEvent) {}
/// A [`Client`](../../struct.Client.html) will call this method on each registered handler when
/// a server heartbeat succeeds.
fn handle_server_heartbeat_succeeded_event(&self, _event: ServerHeartbeatSucceededEvent) {}
/// A [`Client`](../../struct.Client.html) will call this method on each registered handler when
/// a server heartbeat fails.
fn handle_server_heartbeat_failed_event(&self, _event: ServerHeartbeatFailedEvent) {}
}