feat: add telemetery instrumentation using tracing

Cargo.lock

@@ -438,13 +438,14 @@ dependencies = [
  "lazy_static",
  "libconductor",
  "libconfig",
- "log",
  "mime_guess",
  "pretty_env_logger",
  "rust-embed",
  "serde",
  "serde_json",
  "sqlx",
+ "tracing",
+ "tracing-actix-web",
  "url",
 ]
 
@@ -1360,6 +1361,26 @@ dependencies = [
  "sha1",
 ]
 
+[[package]]
+name = "pin-project"
+version = "1.0.12"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "ad29a609b6bcd67fee905812e544992d216af9d755757c05ed2d0e15a74c6ecc"
+dependencies = [
+ "pin-project-internal",
+]
+
+[[package]]
+name = "pin-project-internal"
+version = "1.0.12"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "069bdb1e05adc7a8990dce9cc75370895fbe4e3d58b9b73bf1aee56359344a55"
+dependencies = [
+ "proc-macro2",
+ "quote",
+ "syn",
+]
+
 [[package]]
 name = "pin-project-lite"
 version = "0.2.9"
@@ -2058,9 +2079,33 @@ dependencies = [
  "cfg-if",
  "log",
  "pin-project-lite",
+ "tracing-attributes",
  "tracing-core",
 ]
 
+[[package]]
+name = "tracing-actix-web"
+version = "0.7.1"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "d16c2a0c52b267d46ea9a46012a28b3513ce166c28eaeaa875829ed2f8debd19"
+dependencies = [
+ "actix-web",
+ "pin-project",
+ "tracing",
+ "uuid",
+]
+
+[[package]]
+name = "tracing-attributes"
+version = "0.1.23"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "4017f8f45139870ca7e672686113917c71c7a6e02d4924eda67186083c03081a"
+dependencies = [
+ "proc-macro2",
+ "quote",
+ "syn",
+]
+
 [[package]]
 name = "tracing-core"
 version = "0.1.30"
@@ -2142,6 +2187,15 @@ dependencies = [
  "serde",
 ]
 
+[[package]]
+name = "uuid"
+version = "1.2.2"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "422ee0de9031b5b948b97a8fc04e3aa35230001a722ddd27943e0be31564ce4c"
+dependencies = [
+ "getrandom",
+]
+
 [[package]]
 name = "version_check"
 version = "0.9.4"

Cargo.toml

@@ -15,7 +15,6 @@ actix-web = "4"
 actix-web-prom = "0.6.0"
 futures-util = { version = "0.3.17", default-features = false, features = ["std"] }
 lazy_static = "1.4.0"
-log = "0.4.17"
 pretty_env_logger = "0.4.0"
 serde = { version = "1", features=["derive"]}
 actix-web-codegen-const-routes = { version = "0.1.0", tag = "0.1.0", git = "https://github.com/realaravinth/actix-web-codegen-const-routes" }
@@ -29,6 +28,8 @@ clap = { vesrion = "3.2.20", features = ["derive"]}
 actix-web-httpauth = "0.8.0"
 mime_guess = "2.0.4"
 rust-embed = "6.4.2"
+tracing-actix-web = "0.7.1"
+tracing = { version = "0.1.37", features = ["log"] }
 
 [dependencies.libconductor]
 path = "./env/libconductor"

src/api/v1/meta.rs

@@ -46,6 +46,7 @@ pub mod routes {
 
 /// emits build details of the bninary
 #[actix_web_codegen_const_routes::get(path = "crate::API_V1_ROUTES.meta.build_details")]
+#[tracing::instrument(name = "Get build details", skip(ctx))]
 async fn build_details(ctx: AppCtx) -> impl Responder {
     let build = BuildDetails {
         version: VERSION,
@@ -63,6 +64,7 @@ pub struct Health {
 
 /// checks all components of the system
 #[actix_web_codegen_const_routes::get(path = "crate::API_V1_ROUTES.meta.health")]
+#[tracing::instrument(name = "Get health details", skip(ctx))]
 async fn health(ctx: crate::AppCtx) -> impl Responder {
     let mut resp_builder = HealthBuilder::default();
 

src/api/v1/webhook.rs

@@ -49,6 +49,7 @@ pub fn services(cfg: &mut web::ServiceConfig) {
     path = "API_V1_ROUTES.webhook.post_event",
     wrap = "HttpAuthentication::basic(httpauth)"
 )]
+#[tracing::instrument(name = "Post events to webhook", skip(ctx, payload))]
 async fn post_event(ctx: AppCtx, payload: web::Json<EventType>) -> ServiceResult<impl Responder> {
     ctx.conductor.process(payload.into_inner()).await;
     Ok(HttpResponse::Created())

src/docs.rs

@@ -73,6 +73,7 @@ pub fn handle_embedded_file(path: &str) -> HttpResponse {
 }
 
 #[actix_web_codegen_const_routes::get(path = "DOCS.assets")]
+#[tracing::instrument(name = "Serve Open API docs", skip(path))]
 async fn dist(path: web::Path<String>) -> impl Responder {
     handle_embedded_file(&path)
 }

src/main.rs

@@ -21,7 +21,8 @@ use actix_web::web::JsonConfig;
 use actix_web::{error::InternalError, middleware, App, HttpServer};
 use actix_web_prom::PrometheusMetricsBuilder;
 use clap::{Parser, Subcommand};
-use log::info;
+use tracing::info;
+use tracing_actix_web::TracingLogger;
 
 use lazy_static::lazy_static;
 
@@ -30,34 +31,17 @@ mod ctx;
 mod docs;
 #[cfg(not(tarpaulin_include))]
 mod errors;
-//#[macro_use]
-//mod pages;
-//#[macro_use]
 mod routes;
 mod settings;
-//mod static_assets;
 //#[cfg(test)]
 //#[macro_use]
 //mod tests;
-//
 pub use crate::ctx::Ctx;
-//pub use crate::static_assets::static_files::assets::*;
 pub use api::v1::API_V1_ROUTES;
-//pub use docs::DOCS;
-//pub use pages::routes::ROUTES as PAGES;
 pub use settings::Settings;
-//use static_assets::FileMap;
 
 lazy_static! {
-    pub static ref SETTINGS: Settings= Settings::new().unwrap();
-//    pub static ref S: String = env::var("S").unwrap();
-//    pub static ref FILES: FileMap = FileMap::new();
-//    pub static ref JS: &'static str =
-//        FILES.get("./static/cache/bundle/bundle.js").unwrap();
-//    pub static ref CSS: &'static str =
-//        FILES.get("./static/cache/bundle/css/main.css").unwrap();
-//    pub static ref MOBILE_CSS: &'static str =
-//        FILES.get("./static/cache/bundle/css/mobile.css").unwrap();
+    pub static ref SETTINGS: Settings = Settings::new().unwrap();
 }
 
 pub const COMPILED_DATE: &str = env!("COMPILED_DATE");
@@ -120,7 +104,7 @@ async fn serve(settings: Settings, ctx: AppCtx) -> std::io::Result<()> {
 
     HttpServer::new(move || {
         App::new()
-            .wrap(middleware::Logger::default())
+            .wrap(TracingLogger::default())
             .wrap(
                 middleware::DefaultHeaders::new().add(("Permissions-Policy", "interest-cohort=()")),
             )
@@ -140,8 +124,6 @@ async fn serve(settings: Settings, ctx: AppCtx) -> std::io::Result<()> {
 
 #[cfg(not(tarpaulin_include))]
 pub fn get_json_err() -> JsonConfig {
-    JsonConfig::default().error_handler(|err, _| {
-        //debug!("JSON deserialization error: {:?}", &err);
-        InternalError::new(err, StatusCode::BAD_REQUEST).into()
-    })
+    JsonConfig::default()
+        .error_handler(|err, _| InternalError::new(err, StatusCode::BAD_REQUEST).into())
 }

src/settings.rs

@@ -19,10 +19,10 @@ use std::path::Path;
 
 use config::{builder::DefaultState, Config, ConfigBuilder, ConfigError, Environment, File};
 use derive_more::Display;
-use log::info;
-use log::warn;
 use serde::Deserialize;
 use serde::Serialize;
+use tracing::info;
+use tracing::warn;
 use url::Url;
 
 const PREFIX: &str = "LPCONDUCTOR";