Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Adds new statistics attributes for tracking connections closed #205

Merged
merged 2 commits into from
Jun 13, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions bb8/src/api.rs
Original file line number Diff line number Diff line change
Expand Up @@ -101,6 +101,10 @@ pub struct Statistics {
pub get_timed_out: u64,
/// Total time accumulated waiting for a connection.
pub get_wait_time: Duration,
/// Total connections that were closed due to be in broken state.
pub connections_closed_broken: u64,
/// Total connections that were closed due to be considered invalid.
pub connections_closed_invalid: u64,
}

/// A builder for a connection pool.
Expand Down
14 changes: 9 additions & 5 deletions bb8/src/inner.rs
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ use tokio::spawn;
use tokio::time::{interval_at, sleep, timeout, Interval};

use crate::api::{Builder, ConnectionState, ManageConnection, PooledConnection, RunError, State};
use crate::internals::{Approval, ApprovalIter, Conn, SharedPool, StatsKind};
use crate::internals::{Approval, ApprovalIter, Conn, SharedPool, StatsGetKind, StatsKind};

pub(crate) struct PoolInner<M>
where
Expand Down Expand Up @@ -85,7 +85,7 @@ where
}

pub(crate) async fn get(&self) -> Result<PooledConnection<'_, M>, RunError<M::Error>> {
let mut kind = StatsKind::Direct;
let mut kind = StatsGetKind::Direct;
let mut wait_time_start = None;

let future = async {
Expand All @@ -100,7 +100,7 @@ where
Some(conn) => PooledConnection::new(self, conn),
None => {
wait_time_start = Some(Instant::now());
kind = StatsKind::Waited;
kind = StatsGetKind::Waited;
self.inner.notify.notified().await;
continue;
}
Expand All @@ -113,6 +113,7 @@ where
match self.inner.manager.is_valid(&mut conn).await {
Ok(()) => return Ok(conn),
Err(e) => {
self.inner.statistics.record(StatsKind::ClosedInvalid);
self.inner.forward_error(e);
conn.state = ConnectionState::Invalid;
continue;
Expand All @@ -124,7 +125,7 @@ where
let result = match timeout(self.inner.statics.connection_timeout, future).await {
Ok(result) => result,
_ => {
kind = StatsKind::TimedOut;
kind = StatsGetKind::TimedOut;
Err(RunError::TimedOut)
}
};
Expand All @@ -149,7 +150,10 @@ where
let mut locked = self.inner.internals.lock();
match (state, self.inner.manager.has_broken(&mut conn.conn)) {
(ConnectionState::Present, false) => locked.put(conn, None, self.inner.clone()),
(_, _) => {
(_, is_broken) => {
if is_broken {
self.inner.statistics.record(StatsKind::ClosedBroken);
}
let approvals = locked.dropped(1, &self.inner.statics);
self.spawn_replenishing_approvals(approvals);
self.inner.notify.notify_waiters();
Expand Down
27 changes: 22 additions & 5 deletions bb8/src/internals.rs
Original file line number Diff line number Diff line change
Expand Up @@ -256,14 +256,16 @@ pub(crate) struct AtomicStatistics {
pub(crate) get_waited: AtomicU64,
pub(crate) get_timed_out: AtomicU64,
pub(crate) get_wait_time_micros: AtomicU64,
pub(crate) connections_closed_broken: AtomicU64,
pub(crate) connections_closed_invalid: AtomicU64,
}

impl AtomicStatistics {
pub(crate) fn record_get(&self, kind: StatsKind, wait_time_start: Option<Instant>) {
pub(crate) fn record_get(&self, kind: StatsGetKind, wait_time_start: Option<Instant>) {
match kind {
StatsKind::Direct => self.get_direct.fetch_add(1, Ordering::SeqCst),
StatsKind::Waited => self.get_waited.fetch_add(1, Ordering::SeqCst),
StatsKind::TimedOut => self.get_timed_out.fetch_add(1, Ordering::SeqCst),
StatsGetKind::Direct => self.get_direct.fetch_add(1, Ordering::SeqCst),
StatsGetKind::Waited => self.get_waited.fetch_add(1, Ordering::SeqCst),
StatsGetKind::TimedOut => self.get_timed_out.fetch_add(1, Ordering::SeqCst),
};

if let Some(wait_time_start) = wait_time_start {
Expand All @@ -272,6 +274,14 @@ impl AtomicStatistics {
.fetch_add(wait_time.as_micros() as u64, Ordering::SeqCst);
}
}

pub(crate) fn record(&self, kind: StatsKind) {
match kind {
StatsKind::ClosedBroken => &self.connections_closed_broken,
StatsKind::ClosedInvalid => &self.connections_closed_invalid,
}
.fetch_add(1, Ordering::SeqCst);
}
}

impl From<&AtomicStatistics> for Statistics {
Expand All @@ -281,12 +291,19 @@ impl From<&AtomicStatistics> for Statistics {
get_waited: item.get_waited.load(Ordering::SeqCst),
get_timed_out: item.get_timed_out.load(Ordering::SeqCst),
get_wait_time: Duration::from_micros(item.get_wait_time_micros.load(Ordering::SeqCst)),
connections_closed_broken: item.connections_closed_broken.load(Ordering::SeqCst),
connections_closed_invalid: item.connections_closed_invalid.load(Ordering::SeqCst),
}
}
}

pub(crate) enum StatsKind {
pub(crate) enum StatsGetKind {
Direct,
Waited,
TimedOut,
}

pub(crate) enum StatsKind {
ClosedBroken,
ClosedInvalid,
}
4 changes: 4 additions & 0 deletions bb8/tests/test.rs
Original file line number Diff line number Diff line change
Expand Up @@ -246,6 +246,7 @@ async fn test_drop_on_broken() {
}

assert!(DROPPED.load(Ordering::SeqCst));
assert_eq!(pool.state().statistics.connections_closed_broken, 1);
}

#[tokio::test]
Expand Down Expand Up @@ -453,6 +454,9 @@ async fn test_now_invalid() {
// Now try to get a new connection.
let r = pool.get().await;
assert!(r.is_err());

// both connections in the pool were considered invalid
assert_eq!(pool.state().statistics.connections_closed_invalid, 2);
}

#[tokio::test]
Expand Down
Loading