feat: add o11y crate

Author: ymgyt

Cargo.lock

@@ -23,6 +23,7 @@ futures-util       = { version = "0.3.30" }
 graphql_client     = { version = "0.13.0", default-features = false }
 http               = { version = "0.2" }                                                                                                   # request use 0.2
 moka               = { version = "0.12.4", features = ["future"] }
+opentelemetry_sdk  = { version = "0.21.2" }
 reqwest            = { version = "0.11.23", default-features = false, features = ["rustls-tls", "json"] }
 serde              = { version = "1", features = ["derive"] }
 serde_json         = { version = "1.0.111" }

Cargo.toml

@@ -12,12 +12,12 @@ name        = "synd_api"
 version     = "0.1.0"
 
 [dependencies]
-anyhow = { workspace = true }
-# To use axum 0.7
+synd_o11y = { path = "../synd_o11y" }
+
+anyhow             = { workspace = true }
 async-graphql      = { version = "7.0", features = ["tracing"] }
 async-graphql-axum = { version = "7.0" }
 async-trait        = { workspace = true }
-# TODO configure features
 axum               = { workspace = true }
 chrono             = { workspace = true }
 clap               = { workspace = true, features = ["derive"] }

crates/synd_api/Cargo.toml

@@ -16,9 +16,10 @@ pub mod handler {
     use async_graphql::http::GraphiQLSource;
     use async_graphql_axum::{GraphQLRequest, GraphQLResponse};
     use axum::{response::IntoResponse, Extension};
+    use synd_o11y::audit_span;
     use tracing::Instrument;
 
-    use crate::{audit_span, principal::Principal};
+    use crate::principal::Principal;
 
     use super::SyndSchema;
 

crates/synd_api/src/gql/mod.rs

@@ -3,7 +3,7 @@ use tracing::{error, info};
 use synd_api::{args, dependency::Dependency, serve::listen_and_serve};
 
 fn init_tracing() {
-    use synd_api::serve::layer::audit;
+    use synd_o11y::tracing_subscriber::audit;
     use tracing_subscriber::{
         filter::EnvFilter, fmt, layer::SubscriberExt, util::SubscriberInitExt as _, Layer as _,
         Registry,

crates/synd_api/src/main.rs

@@ -1,3 +1,2 @@
-pub mod audit;
 pub mod authenticate;
 pub mod trace;

crates/synd_api/src/serve/layer/mod.rs

@@ -18,12 +18,11 @@ pub mod authorize;
 use std::{future::Future, sync::Arc};
 
 use synd_feed::feed::cache::FetchCachedFeed;
+use synd_o11y::{audit, tracing_subscriber::audit::Audit};
 
 use crate::{
-    audit,
     persistence::{Datastore, DatastoreError},
     principal::Principal,
-    serve::layer::audit::Audit,
 };
 
 use self::authorize::{Authorized, Authorizer, Unauthorized};

crates/synd_api/src/usecase/mod.rs

@@ -0,0 +1,21 @@
+[package]
+authors.workspace    = true
+categories.workspace = true
+edition.workspace    = true
+keywords.workspace   = true
+license.workspace    = true
+readme.workspace     = true
+repository.workspace = true
+
+description = "syndicationd lib for tracing and opentelemetry ecosystem"
+name        = "synd_o11y"
+version     = "0.1.0"
+
+[dependencies]
+opentelemetry-appender-tracing = "0.2.0"
+opentelemetry_sdk              = { workspace = true, features = ["logs"] }
+tracing                        = { workspace = true }
+tracing-subscriber             = { workspace = true }
+
+[lints]
+workspace = true

crates/synd_o11y/Cargo.toml

@@ -0,0 +1 @@
+pub mod tracing_subscriber;

crates/synd_o11y/src/lib.rs

@@ -17,17 +17,17 @@ mod macros {
     macro_rules! audit_span {
         () => {
             ::tracing::info_span!(
-                target: $crate::serve::layer::audit::Audit::TARGET,
-                $crate::serve::layer::audit::Audit::SPAN_ROOT_NAME)
+                target: $crate::tracing_subscriber::audit::Audit::TARGET,
+                $crate::tracing_subscriber::audit::Audit::SPAN_ROOT_NAME)
         };
     }
 
     #[macro_export]
     macro_rules! audit {
         ($($arg:tt)*) => {
             ::tracing::event!(
-                name: $crate::serve::layer::audit::Audit::EVENT_NAME,
-                target: $crate::serve::layer::audit::Audit::TARGET,
+                name: $crate::tracing_subscriber::audit::Audit::EVENT_NAME,
+                target: $crate::tracing_subscriber::audit::Audit::TARGET,
                 ::tracing::Level::TRACE, $($arg)*)
         };
     }
@@ -233,7 +233,7 @@ mod tests {
     mod usecase_authorize_scenario {
         use tracing::info_span;
 
-        use crate::{audit, audit_span, serve::layer::audit::Audit};
+        use crate::{audit, audit_span, tracing_subscriber::audit::Audit};
 
         pub fn root() {
             let span = audit_span!();
@@ -293,9 +293,7 @@ mod tests {
     #[test]
     fn no_audit_span() {
         let on_event = |event: &Event<'_>| {
-            if event.metadata().name() == Audit::EMIT_EVENT_NAME {
-                panic!("should not called");
-            }
+            assert_eq!(event.metadata().name(), Audit::EMIT_EVENT_NAME);
         };
         let test_layer = TestLayer { on_event };
         let subscriber = tracing_subscriber::registry()

crates/synd_api/src/serve/layer/audit.rs crates/synd_o11y/src/tracing_subscriber/audit/mod.rs

@@ -0,0 +1 @@
+pub mod audit;

crates/synd_o11y/src/tracing_subscriber/mod.rs

@@ -13,7 +13,6 @@ version = "0.1.0"
 
 [dependencies]
 synd_authn = { path = "../synd_authn" }
-synd_term  = { path = "../synd_term" }
 
 anyhow = { workspace = true }
 axum   = { workspace = true }