feat: [#1358] new metric in torrent-repository: total number of torrents

Author: josecelano

packages/http-tracker-core/src/statistics/event/handler.rs

@@ -9,10 +9,6 @@ use crate::event::Event;
 use crate::statistics::repository::Repository;
 use crate::statistics::HTTP_TRACKER_CORE_REQUESTS_RECEIVED_TOTAL;
 
-/// # Panics
-///
-/// This function panics if the client IP address is not the same as the IP
-/// version of the event.
 pub async fn handle_event(event: Event, stats_repository: &Arc<Repository>, now: DurationSinceUnixEpoch) {
     match event {
         Event::TcpAnnounce { connection, .. } => {

packages/metrics/src/metric_collection.rs

@@ -140,7 +140,12 @@ impl MetricCollection {
     ///
     /// Return an error if a metrics of a different type with the same name
     /// already exists.
-    pub fn increase_gauge(&mut self, name: &MetricName, label_set: &LabelSet, time: DurationSinceUnixEpoch) -> Result<(), Error> {
+    pub fn increment_gauge(
+        &mut self,
+        name: &MetricName,
+        label_set: &LabelSet,
+        time: DurationSinceUnixEpoch,
+    ) -> Result<(), Error> {
         if self.counters.metrics.contains_key(name) {
             return Err(Error::MetricNameCollisionAdding {
                 metric_name: name.clone(),
@@ -156,7 +161,12 @@ impl MetricCollection {
     ///
     /// Return an error if a metrics of a different type with the same name
     /// already exists.
-    pub fn decrease_gauge(&mut self, name: &MetricName, label_set: &LabelSet, time: DurationSinceUnixEpoch) -> Result<(), Error> {
+    pub fn decrement_gauge(
+        &mut self,
+        name: &MetricName,
+        label_set: &LabelSet,
+        time: DurationSinceUnixEpoch,
+    ) -> Result<(), Error> {
         if self.counters.metrics.contains_key(name) {
             return Err(Error::MetricNameCollisionAdding {
                 metric_name: name.clone(),

packages/torrent-repository/src/statistics/event/handler.rs

@@ -1,23 +1,36 @@
 use std::sync::Arc;
 
+use torrust_tracker_metrics::label::LabelSet;
+use torrust_tracker_metrics::metric_name;
 use torrust_tracker_primitives::DurationSinceUnixEpoch;
 
 use crate::event::Event;
 use crate::statistics::repository::Repository;
+use crate::statistics::TORRENT_REPOSITORY_TORRENTS_TOTAL;
 
-/// # Panics
-///
-/// This function panics if the client IP address is not the same as the IP
-/// version of the event.
-pub async fn handle_event(event: Event, stats_repository: &Arc<Repository>, _now: DurationSinceUnixEpoch) {
+pub async fn handle_event(event: Event, stats_repository: &Arc<Repository>, now: DurationSinceUnixEpoch) {
     match event {
         Event::TorrentAdded { info_hash, .. } => {
-            // todo: update metrics
             tracing::debug!("Torrent added {info_hash}");
+
+            match stats_repository
+                .increment_gauge(&metric_name!(TORRENT_REPOSITORY_TORRENTS_TOTAL), &LabelSet::default(), now)
+                .await
+            {
+                Ok(()) => {}
+                Err(err) => tracing::error!("Failed to increment the gauge: {}", err),
+            };
         }
         Event::TorrentRemoved { info_hash } => {
-            // todo: update metrics
             tracing::debug!("Torrent removed {info_hash}");
+
+            match stats_repository
+                .decrement_gauge(&metric_name!(TORRENT_REPOSITORY_TORRENTS_TOTAL), &LabelSet::default(), now)
+                .await
+            {
+                Ok(()) => {}
+                Err(err) => tracing::error!("Failed to decrement the gauge: {}", err),
+            };
         }
         Event::PeerAdded { announcement } => {
             // todo: update metrics
@@ -28,6 +41,4 @@ pub async fn handle_event(event: Event, stats_repository: &Arc<Repository>, _now
             tracing::debug!("Peer removed: socket address {socket_addr:?}, peer ID: {peer_id:?}");
         }
     }
-
-    tracing::debug!("metrics: {:?}", stats_repository.get_metrics().await);
 }

packages/torrent-repository/src/statistics/metrics.rs

@@ -15,7 +15,7 @@ impl Metrics {
     /// # Errors
     ///
     /// Returns an error if the metric does not exist and it cannot be created.
-    pub fn increase_counter(
+    pub fn increment_counter(
         &mut self,
         metric_name: &MetricName,
         labels: &LabelSet,
@@ -36,4 +36,28 @@ impl Metrics {
     ) -> Result<(), Error> {
         self.metric_collection.set_gauge(metric_name, labels, value, now)
     }
+
+    /// # Errors
+    ///
+    /// Returns an error if the metric does not exist and it cannot be created.
+    pub fn increment_gauge(
+        &mut self,
+        metric_name: &MetricName,
+        labels: &LabelSet,
+        now: DurationSinceUnixEpoch,
+    ) -> Result<(), Error> {
+        self.metric_collection.increment_gauge(metric_name, labels, now)
+    }
+
+    /// # Errors
+    ///
+    /// Returns an error if the metric does not exist and it cannot be created.
+    pub fn decrement_gauge(
+        &mut self,
+        metric_name: &MetricName,
+        labels: &LabelSet,
+        now: DurationSinceUnixEpoch,
+    ) -> Result<(), Error> {
+        self.metric_collection.decrement_gauge(metric_name, labels, now)
+    }
 }

packages/torrent-repository/src/statistics/mod.rs

@@ -7,12 +7,19 @@ use torrust_tracker_metrics::metric::description::MetricDescription;
 use torrust_tracker_metrics::metric_name;
 use torrust_tracker_metrics::unit::Unit;
 
+const TORRENT_REPOSITORY_TORRENTS_TOTAL: &str = "torrent_repository_torrents_total";
 const TORRENT_REPOSITORY_RUNTIME_TORRENTS_DOWNLOADS_TOTAL: &str = "torrent_repository_runtime_torrents_downloads_total";
 
 #[must_use]
 pub fn describe_metrics() -> Metrics {
     let mut metrics = Metrics::default();
 
+    metrics.metric_collection.describe_gauge(
+        &metric_name!(TORRENT_REPOSITORY_TORRENTS_TOTAL),
+        Some(Unit::Count),
+        Some(&MetricDescription::new("The total number of torrents.")),
+    );
+
     metrics.metric_collection.describe_counter(
         &metric_name!(TORRENT_REPOSITORY_RUNTIME_TORRENTS_DOWNLOADS_TOTAL),
         Some(Unit::Count),

packages/torrent-repository/src/statistics/repository.rs

@@ -36,16 +36,54 @@ impl Repository {
     /// # Errors
     ///
     /// This function will return an error if the metric collection fails to
-    /// increase the counter.
-    pub async fn increase_counter(
+    /// increment the counter.
+    pub async fn increment_counter(
         &self,
         metric_name: &MetricName,
         labels: &LabelSet,
         now: DurationSinceUnixEpoch,
     ) -> Result<(), Error> {
         let mut stats_lock = self.stats.write().await;
 
-        let result = stats_lock.increase_counter(metric_name, labels, now);
+        let result = stats_lock.increment_counter(metric_name, labels, now);
+
+        drop(stats_lock);
+
+        result
+    }
+
+    /// # Errors
+    ///
+    /// This function will return an error if the metric collection fails to
+    /// increment the gauge.
+    pub async fn increment_gauge(
+        &self,
+        metric_name: &MetricName,
+        labels: &LabelSet,
+        now: DurationSinceUnixEpoch,
+    ) -> Result<(), Error> {
+        let mut stats_lock = self.stats.write().await;
+
+        let result = stats_lock.increment_gauge(metric_name, labels, now);
+
+        drop(stats_lock);
+
+        result
+    }
+
+    /// # Errors
+    ///
+    /// This function will return an error if the metric collection fails to
+    /// decrement the gauge.
+    pub async fn decrement_gauge(
+        &self,
+        metric_name: &MetricName,
+        labels: &LabelSet,
+        now: DurationSinceUnixEpoch,
+    ) -> Result<(), Error> {
+        let mut stats_lock = self.stats.write().await;
+
+        let result = stats_lock.decrement_gauge(metric_name, labels, now);
 
         drop(stats_lock);
 

packages/torrent-repository/src/swarms.rs

@@ -299,9 +299,15 @@ impl Swarms {
                 continue;
             }
 
+            let info_hash = *swarm_handle.key();
+
             swarm_handle.remove();
 
             peerless_torrents_removed += 1;
+
+            if let Some(event_sender) = self.event_sender.as_deref() {
+                event_sender.send(Event::TorrentRemoved { info_hash }).await;
+            }
         }
 
         tracing::info!(peerless_torrents_removed = peerless_torrents_removed);