Merge torrust#1413: health_check: service type

99aa259 health_check: service_type field (nuts_rice)

Pull request description:

  addresses torrust#1409 by introducing a `service_type` field for `ServiceHealthCheckJob`
  displays when accessing /health_check endpoint

ACKs for top commit:
  da2ce7:
    utACK 99aa259
  josecelano:
    ACK 99aa259

Tree-SHA512: 00331da6889b806a123a69e0293e4beb1675127473218d16f3fd1f5bf64b2f6eae25ef4ae720ebd829ed936338f3b01f84acb74c2157dbac330fd42ff20f9e61

Author: josecelano

packages/axum-health-check-api-server/src/handlers.rs

@@ -33,6 +33,7 @@ pub(crate) async fn health_check_handler(State(register): State<ServiceRegistry>
             CheckReport {
                 binding: c.binding,
                 info: c.info.clone(),
+                service_type: c.service_type,
                 result: c.job.await.expect("it should be able to join into the checking function"),
             }
         })

packages/axum-health-check-api-server/src/resources.rs

@@ -12,6 +12,7 @@ pub enum Status {
 #[derive(Clone, Serialize, Deserialize, Debug, PartialEq, Eq)]
 pub struct CheckReport {
     pub binding: SocketAddr,
+    pub service_type: String,
     pub info: String,
     pub result: Result<String, String>,
 }

packages/axum-http-tracker-server/src/server.rs

@@ -18,6 +18,7 @@ use tracing::instrument;
 use super::v1::routes::router;
 use crate::HTTP_TRACKER_LOG_TARGET;
 
+const TYPE_STRING: &str = "http_tracker";
 /// Error that can occur when starting or stopping the HTTP server.
 ///
 /// Some errors triggered while starting the server are:
@@ -231,7 +232,7 @@ pub fn check_fn(binding: &SocketAddr) -> ServiceHealthCheckJob {
         }
     });
 
-    ServiceHealthCheckJob::new(*binding, info, job)
+    ServiceHealthCheckJob::new(*binding, info, TYPE_STRING.to_string(), job)
 }
 
 #[cfg(test)]

packages/axum-rest-tracker-api-server/src/server.rs

@@ -45,6 +45,8 @@ use tracing::{instrument, Level};
 use super::routes::router;
 use crate::API_LOG_TARGET;
 
+const TYPE_STRING: &str = "tracker_rest_api";
+
 /// Errors that can occur when starting or stopping the API server.
 #[derive(Debug, Error)]
 pub enum Error {
@@ -204,7 +206,7 @@ pub fn check_fn(binding: &SocketAddr) -> ServiceHealthCheckJob {
             Err(err) => Err(err.to_string()),
         }
     });
-    ServiceHealthCheckJob::new(*binding, info, job)
+    ServiceHealthCheckJob::new(*binding, info, TYPE_STRING.to_string(), job)
 }
 
 /// A struct responsible for starting the API server.

packages/server-lib/src/registar.rs

@@ -18,6 +18,7 @@ pub type ServiceHeathCheckResult = Result<String, String>;
 pub struct ServiceHealthCheckJob {
     pub binding: SocketAddr,
     pub info: String,
+    pub service_type: String,
     pub job: JoinHandle<ServiceHeathCheckResult>,
 }
 

packages/udp-tracker-server/src/server/launcher.rs

@@ -24,6 +24,7 @@ use crate::server::receiver::Receiver;
 
 const IP_BANS_RESET_INTERVAL_IN_SECS: u64 = 3600;
 
+const TYPE_STRING: &str = "udp_tracker";
 /// A UDP server instance launcher.
 #[derive(Constructor)]
 pub struct Launcher;
@@ -117,7 +118,7 @@ impl Launcher {
 
         let job = tokio::spawn(async move { check(&binding).await });
 
-        ServiceHealthCheckJob::new(binding, info, job)
+        ServiceHealthCheckJob::new(binding, info, TYPE_STRING.to_string(), job)
     }
 
     #[instrument(skip(receiver, udp_tracker_core_container, udp_tracker_server_container))]