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

Overhaul stats: Use broadcast channel for events in UDP Server #1394

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
6 changes: 3 additions & 3 deletions packages/udp-tracker-server/src/handlers/announce.rs
Original file line number Diff line number Diff line change
Expand Up @@ -430,7 +430,7 @@ mod tests {
kind: UdpRequestKind::Announce,
}))
.times(1)
.returning(|_| Box::pin(future::ready(Some(Ok(())))));
.returning(|_| Box::pin(future::ready(Some(Ok(1)))));
let udp_server_stats_event_sender: Arc<Option<Box<dyn server_statistics::event::sender::Sender>>> =
Arc::new(Some(Box::new(udp_server_stats_event_sender_mock)));

Expand Down Expand Up @@ -773,7 +773,7 @@ mod tests {
kind: UdpRequestKind::Announce,
}))
.times(1)
.returning(|_| Box::pin(future::ready(Some(Ok(())))));
.returning(|_| Box::pin(future::ready(Some(Ok(1)))));
let udp_server_stats_event_sender: Arc<Option<Box<dyn server_statistics::event::sender::Sender>>> =
Arc::new(Some(Box::new(udp_server_stats_event_sender_mock)));

Expand Down Expand Up @@ -866,7 +866,7 @@ mod tests {
kind: UdpRequestKind::Announce,
}))
.times(1)
.returning(|_| Box::pin(future::ready(Some(Ok(())))));
.returning(|_| Box::pin(future::ready(Some(Ok(1)))));
let udp_server_stats_event_sender: Arc<Option<Box<dyn server_statistics::event::sender::Sender>>> =
Arc::new(Some(Box::new(udp_server_stats_event_sender_mock)));

Expand Down
4 changes: 2 additions & 2 deletions packages/udp-tracker-server/src/handlers/connect.rs
Original file line number Diff line number Diff line change
Expand Up @@ -208,7 +208,7 @@ mod tests {
kind: UdpRequestKind::Connect,
}))
.times(1)
.returning(|_| Box::pin(future::ready(Some(Ok(())))));
.returning(|_| Box::pin(future::ready(Some(Ok(1)))));
let udp_server_stats_event_sender: Arc<Option<Box<dyn server_statistics::event::sender::Sender>>> =
Arc::new(Some(Box::new(udp_server_stats_event_sender_mock)));

Expand Down Expand Up @@ -249,7 +249,7 @@ mod tests {
kind: UdpRequestKind::Connect,
}))
.times(1)
.returning(|_| Box::pin(future::ready(Some(Ok(())))));
.returning(|_| Box::pin(future::ready(Some(Ok(1)))));
let udp_server_stats_event_sender: Arc<Option<Box<dyn server_statistics::event::sender::Sender>>> =
Arc::new(Some(Box::new(udp_server_stats_event_sender_mock)));

Expand Down
3 changes: 1 addition & 2 deletions packages/udp-tracker-server/src/handlers/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -223,7 +223,6 @@ pub(crate) mod tests {
use futures::future::BoxFuture;
use mockall::mock;
use tokio::sync::broadcast::error::SendError;
use tokio::sync::mpsc::error::SendError as MpscSendError;
use torrust_tracker_clock::clock::Time;
use torrust_tracker_configuration::{Configuration, Core};
use torrust_tracker_primitives::{peer, DurationSinceUnixEpoch};
Expand Down Expand Up @@ -430,7 +429,7 @@ pub(crate) mod tests {
mock! {
pub(crate) UdpServerStatsEventSender {}
impl server_statistics::event::sender::Sender for UdpServerStatsEventSender {
fn send_event(&self, event: server_statistics::event::Event) -> BoxFuture<'static,Option<Result<(),MpscSendError<server_statistics::event::Event> > > > ;
fn send_event(&self, event: server_statistics::event::Event) -> BoxFuture<'static,Option<Result<usize,SendError<server_statistics::event::Event> > > > ;
}
}
}
4 changes: 2 additions & 2 deletions packages/udp-tracker-server/src/handlers/scrape.rs
Original file line number Diff line number Diff line change
Expand Up @@ -373,7 +373,7 @@ mod tests {
kind: server_statistics::event::UdpRequestKind::Scrape,
}))
.times(1)
.returning(|_| Box::pin(future::ready(Some(Ok(())))));
.returning(|_| Box::pin(future::ready(Some(Ok(1)))));
let udp_server_stats_event_sender: Arc<Option<Box<dyn server_statistics::event::sender::Sender>>> =
Arc::new(Some(Box::new(udp_server_stats_event_sender_mock)));

Expand Down Expand Up @@ -422,7 +422,7 @@ mod tests {
kind: server_statistics::event::UdpRequestKind::Scrape,
}))
.times(1)
.returning(|_| Box::pin(future::ready(Some(Ok(())))));
.returning(|_| Box::pin(future::ready(Some(Ok(1)))));
let udp_server_stats_event_sender: Arc<Option<Box<dyn server_statistics::event::sender::Sender>>> =
Arc::new(Some(Box::new(udp_server_stats_event_sender_mock)));

Expand Down
14 changes: 10 additions & 4 deletions packages/udp-tracker-server/src/statistics/event/listener.rs
Original file line number Diff line number Diff line change
@@ -1,11 +1,17 @@
use tokio::sync::mpsc;
use tokio::sync::broadcast;

use super::handler::handle_event;
use super::Event;
use crate::statistics::repository::Repository;

pub async fn dispatch_events(mut receiver: mpsc::Receiver<Event>, stats_repository: Repository) {
while let Some(event) = receiver.recv().await {
handle_event(event, &stats_repository).await;
pub async fn dispatch_events(mut receiver: broadcast::Receiver<Event>, stats_repository: Repository) {
loop {
match receiver.recv().await {
Ok(event) => handle_event(event, &stats_repository).await,
Err(e) => {
tracing::error!("Error receiving udp tracker server event: {:?}", e);
break;
}
}
}
}
12 changes: 6 additions & 6 deletions packages/udp-tracker-server/src/statistics/event/sender.rs
Original file line number Diff line number Diff line change
Expand Up @@ -2,15 +2,15 @@ use futures::future::BoxFuture;
use futures::FutureExt;
#[cfg(test)]
use mockall::{automock, predicate::str};
use tokio::sync::mpsc;
use tokio::sync::mpsc::error::SendError;
use tokio::sync::broadcast;
use tokio::sync::broadcast::error::SendError;

use super::Event;

/// A trait to allow sending statistics events
#[cfg_attr(test, automock)]
pub trait Sender: Sync + Send {
fn send_event(&self, event: Event) -> BoxFuture<'_, Option<Result<(), SendError<Event>>>>;
fn send_event(&self, event: Event) -> BoxFuture<'_, Option<Result<usize, SendError<Event>>>>;
}

/// An [`statistics::EventSender`](crate::statistics::event::sender::Sender) implementation.
Expand All @@ -19,11 +19,11 @@ pub trait Sender: Sync + Send {
/// [`statistics::Keeper`](crate::statistics::keeper::Keeper)
#[allow(clippy::module_name_repetitions)]
pub struct ChannelSender {
pub(crate) sender: mpsc::Sender<Event>,
pub(crate) sender: broadcast::Sender<Event>,
}

impl Sender for ChannelSender {
fn send_event(&self, event: Event) -> BoxFuture<'_, Option<Result<(), SendError<Event>>>> {
async move { Some(self.sender.send(event).await) }.boxed()
fn send_event(&self, event: Event) -> BoxFuture<'_, Option<Result<usize, SendError<Event>>>> {
async move { Some(self.sender.send(event)) }.boxed()
}
}
41 changes: 2 additions & 39 deletions packages/udp-tracker-server/src/statistics/keeper.rs
Original file line number Diff line number Diff line change
@@ -1,12 +1,9 @@
use tokio::sync::mpsc;
use tokio::sync::broadcast::Receiver;

use super::event::listener::dispatch_events;
use super::event::sender::{ChannelSender, Sender};
use super::event::Event;
use super::repository::Repository;

const CHANNEL_BUFFER_SIZE: usize = 65_535;

/// The service responsible for keeping tracker metrics (listening to statistics events and handle them).
///
/// It actively listen to new statistics events. When it receives a new event
Expand All @@ -29,31 +26,15 @@ impl Keeper {
}
}

#[must_use]
pub fn new_active_instance() -> (Box<dyn Sender>, Repository) {
let mut stats_tracker = Self::new();

let stats_event_sender = stats_tracker.run_event_listener();

(stats_event_sender, stats_tracker.repository)
}

pub fn run_event_listener(&mut self) -> Box<dyn Sender> {
let (sender, receiver) = mpsc::channel::<Event>(CHANNEL_BUFFER_SIZE);

pub fn run_event_listener(&mut self, receiver: Receiver<Event>) {
let stats_repository = self.repository.clone();

tokio::spawn(async move { dispatch_events(receiver, stats_repository).await });

Box::new(ChannelSender { sender })
}
}

#[cfg(test)]
mod tests {
use std::net::{IpAddr, Ipv6Addr, SocketAddr};

use crate::statistics::event::{ConnectionContext, Event};
use crate::statistics::keeper::Keeper;
use crate::statistics::metrics::Metrics;

Expand All @@ -65,22 +46,4 @@ mod tests {

assert_eq!(stats.udp4_requests, Metrics::default().udp4_requests);
}

#[tokio::test]
async fn should_create_an_event_sender_to_send_statistical_events() {
let mut stats_tracker = Keeper::new();

let event_sender = stats_tracker.run_event_listener();

let result = event_sender
.send_event(Event::UdpRequestReceived {
context: ConnectionContext::new(
SocketAddr::new(IpAddr::V6(Ipv6Addr::new(0, 0, 0, 0, 203, 0, 113, 195)), 8080),
SocketAddr::new(IpAddr::V6(Ipv6Addr::new(0, 0, 0, 0, 203, 0, 113, 196)), 6969),
),
})
.await;

assert!(result.is_some());
}
}
19 changes: 15 additions & 4 deletions packages/udp-tracker-server/src/statistics/setup.rs
Original file line number Diff line number Diff line change
@@ -1,8 +1,13 @@
//! Setup for the tracker statistics.
//!
//! The [`factory`] function builds the structs needed for handling the tracker metrics.
use tokio::sync::broadcast;

use super::event::sender::ChannelSender;
use crate::statistics;

const CHANNEL_CAPACITY: usize = 1024;

/// It builds the structs needed for handling the tracker metrics.
///
/// It returns:
Expand All @@ -19,15 +24,21 @@ pub fn factory(
Option<Box<dyn statistics::event::sender::Sender>>,
statistics::repository::Repository,
) {
let mut stats_event_sender = None;
let mut stats_event_sender: Option<Box<dyn statistics::event::sender::Sender>> = None;

let mut stats_tracker = statistics::keeper::Keeper::new();
let mut keeper = statistics::keeper::Keeper::new();

if tracker_usage_statistics {
stats_event_sender = Some(stats_tracker.run_event_listener());
let (sender, _) = broadcast::channel(CHANNEL_CAPACITY);

let receiver = sender.subscribe();

stats_event_sender = Some(Box::new(ChannelSender { sender }));

keeper.run_event_listener(receiver);
}

(stats_event_sender, stats_tracker.repository)
(stats_event_sender, keeper.repository)
}

#[cfg(test)]
Expand Down
Loading