feat: [torrust#508] add container healthcheck for API

Author: josecelano

Containerfile

@@ -85,7 +85,7 @@ COPY --from=build \
 RUN cargo nextest run --workspace-remap /test/src/ --extract-to /test/src/ --no-run --archive-file /test/torrust-tracker.tar.zst
 RUN cargo nextest run --workspace-remap /test/src/ --target-dir-remap /test/src/target/ --cargo-metadata /test/src/target/nextest/cargo-metadata.json --binaries-metadata /test/src/target/nextest/binaries-metadata.json
 
-RUN mkdir -p /app/bin/; cp -l /test/src/target/release/torrust-tracker /app/bin/torrust-tracker
+RUN mkdir -p /app/bin/; cp -l /test/src/target/release/torrust-tracker /app/bin/torrust-tracker; cp -l /test/src/target/release/http_health_check /app/bin/http_health_check
 RUN mkdir -p /app/lib/; cp -l $(realpath $(ldd /app/bin/torrust-tracker | grep "libz\.so\.1" | awk '{print $3}')) /app/lib/libz.so.1
 RUN chown -R root:root /app; chmod -R u=rw,go=r,a+X /app; chmod -R a+x /app/bin
 
@@ -136,5 +136,7 @@ CMD ["sh"]
 FROM runtime as release
 ENV RUNTIME="release"
 COPY --from=test /app/ /usr/
-# HEALTHCHECK CMD ["/usr/bin/wget", "--no-verbose", "--tries=1", "--spider", "localhost:${API_PORT}/version"]
+HEALTHCHECK --interval=5s --timeout=5s --start-period=3s --retries=3 \  
+  CMD /usr/bin/http_health_check http://localhost:${API_PORT}/health_check \
+    || exit 1
 CMD ["/usr/bin/torrust-tracker"]

src/bin/http_health_check.rs

@@ -10,8 +10,8 @@ use std::{env, process};
 async fn main() {
     let args: Vec<String> = env::args().collect();
     if args.len() != 2 {
-        eprintln!("Usage:   cargo run --bin health_check <HEALTH_URL>");
-        eprintln!("Example: cargo run --bin http_health_check http://localhost:1212/api/v1/stats?token=MyAccessToken");
+        eprintln!("Usage:   cargo run --bin http_health_check <HEALTH_URL>");
+        eprintln!("Example: cargo run --bin http_health_check http://127.0.0.1:1212/health_check");
         std::process::exit(1);
     }
 
@@ -34,4 +34,4 @@ async fn main() {
             process::exit(1);
         }
     }
-}
+}

src/servers/apis/routes.rs

@@ -7,7 +7,9 @@
 //! first path segment. For example: `/api/v1/torrents`.
 use std::sync::Arc;
 
-use axum::{middleware, Router};
+use axum::routing::get;
+use axum::{middleware, Json, Router};
+use serde_json::{json, Value};
 use tower_http::compression::CompressionLayer;
 
 use super::v1;
@@ -18,14 +20,20 @@ use crate::tracker::Tracker;
 pub fn router(tracker: Arc<Tracker>) -> Router {
     let router = Router::new();
 
-    let prefix = "/api";
+    let api_url_prefix = "/api";
 
-    let router = v1::routes::add(prefix, router, tracker.clone());
+    let router = v1::routes::add(api_url_prefix, router, tracker.clone());
 
     router
         .layer(middleware::from_fn_with_state(
             tracker.config.clone(),
             v1::middlewares::auth::auth,
         ))
+        .route("/health_check", get(health_check_handler))
         .layer(CompressionLayer::new())
 }
+
+/// Endpoint for container health check.
+async fn health_check_handler() -> Json<Value> {
+    Json(json!({ "status": "Ok" }))
+}