Feature/new logger (#14)

* feat: add new logger package using tokio tracing

* feat: adjustments to use new logger module

* feat: export serde_json declaration

* chore: update examples

* chore: update README file

* docs: update definitions documentation

Author: rsfreitas

Cargo.toml

@@ -6,12 +6,13 @@ edition = "2021"
 [dependencies]
 async-trait = "0.1.83"
 axum = "0.7.7"
+chrono = "0.4.38"
 env-settings = "0.1.11"
 env-settings-derive = "0.1.11"
 env-settings-utils = "0.1.11"
 futures = "0.3.31"
 http = "1.1.0"
-logger = { git = "https://github.com/rsfreitas/logger" }
+indexmap = { version = "2.7.0", features = ["serde"]}
 prost = "0.13.3"
 serde = "1.0.214"
 serde_derive = "1.0.214"
@@ -21,4 +22,6 @@ toml = "0.8.19"
 tonic = { version = "0.12.3", features = ["transport"]}
 tower = "0.5.1"
 tower-service = "0.3.3"
+tracing = "0.1.41"
+tracing-subscriber = { version = "0.3", features = ["env-filter", "json"] }
 validator = { version = "0.19.0", features = ["derive"] }

README.md

@@ -109,28 +109,20 @@ product = "Matrix"
 When executed, it outputs the following (with a different time according the execution):
 
 ```bash
-2024-11-21 22:08:04.415725 -03:00	INFO	service starting	{"local.ts":1732237684,"svc.version":"v0.1.0","svc.language":"rust","local.ts_ms":1732237684415,"svc.name":"script-example","svc.product":"Matrix"}
-2024-11-21 22:08:04.416153 -03:00	INFO	starting features	{"local.ts":1732237684,"svc.version":"v0.1.0","svc.language":"rust","local.ts_ms":1732237684416,"svc.name":"script-example","svc.product":"Matrix"}
-lifecycle on_start
-2024-11-21 22:08:04.416174 -03:00	INFO	service resources	{"local.ts":1732237684,"svc.version":"v0.1.0","svc.language":"rust","local.ts_ms":1732237684416,"svc.name":"script-example","svc.product":"Matrix"}
-2024-11-21 22:08:04.416194 -03:00	INFO	service is running	{"local.ts":1732237684,"svc.version":"v0.1.0","svc.language":"rust","local.ts_ms":1732237684416,"kind":"script","svc.name":"script-example","svc.product":"Matrix"}
-2024-11-21 22:08:04.416218 -03:00	INFO	Stop script service	{"local.ts":1732237684,"svc.version":"v0.1.0","svc.language":"rust","local.ts_ms":1732237684416,"svc.name":"script-example","svc.product":"Matrix"}
-2024-11-21 22:08:04.416234 -03:00	DEBUG	sending shutdown signal for service tasks	{"local.ts":1732237684,"svc.version":"v0.1.0","svc.language":"rust","local.ts_ms":1732237684416,"svc.name":"script-example","svc.product":"Matrix"}
-2024-11-21 22:08:04.416250 -03:00	DEBUG	starting service task	{"local.ts":1732237684,"svc.version":"v0.1.0","svc.language":"rust","local.ts_ms":1732237684416,"task_name":"script","svc.name":"script-example","svc.product":"Matrix"}
-2024-11-21 22:08:04.416351 -03:00	INFO	Start script service	{"local.ts":1732237684,"svc.version":"v0.1.0","svc.language":"rust","local.ts_ms":1732237684416,"svc.name":"script-example","svc.product":"Matrix"}
-2024-11-21 22:08:04.416370 -03:00	DEBUG	finishing service task	{"local.ts":1732237684,"svc.version":"v0.1.0","svc.language":"rust","local.ts_ms":1732237684416,"task_name":"script","svc.name":"script-example","svc.product":"Matrix"}
-2024-11-21 22:08:04.416388 -03:00	DEBUG	service task finished	{"local.ts":1732237684,"svc.version":"v0.1.0","svc.language":"rust","local.ts_ms":1732237684416,"task_name":"script","svc.name":"script-example","svc.product":"Matrix"}
-lifecycle on_finish
-2024-11-21 22:08:04.416436 -03:00	INFO	service stopped	{"local.ts":1732237684,"svc.version":"v0.1.0","svc.language":"rust","local.ts_ms":1732237684416,"svc.name":"script-example","svc.product":"Matrix"}
+{"timestamp":"2024-12-04T07:09:02.173335-03:00","level":"INFO","message":"service starting","svc.name":"script-example","svc.version":"v0.1.0","svc.product":"Matrix","svc.language":"rust"}
+{"timestamp":"2024-12-04T07:09:02.173715-03:00","level":"INFO","message":"starting features","svc.name":"script-example","svc.version":"v0.1.0","svc.product":"Matrix","svc.language":"rust"}
+{"timestamp":"2024-12-04T07:09:02.173840-03:00","level":"INFO","message":"service resources","svc.name":"script-example","svc.version":"v0.1.0","svc.product":"Matrix","svc.language":"rust","example":{"test":"Hello world"}}
+{"timestamp":"2024-12-04T07:09:02.173919-03:00","level":"INFO","message":"service is running","svc.name":"script-example","svc.version":"v0.1.0","svc.product":"Matrix","svc.language":"rust","kind":"script"}
+{"timestamp":"2024-12-04T07:09:02.174001-03:00","level":"INFO","message":"Stop script service","svc.name":"script-example","svc.version":"v0.1.0","svc.product":"Matrix","svc.language":"rust"}
+{"timestamp":"2024-12-04T07:09:02.174056-03:00","level":"INFO","message":"Start script service","svc.name":"script-example","svc.version":"v0.1.0","svc.product":"Matrix","svc.language":"rust"}
+{"timestamp":"2024-12-04T07:09:02.174296-03:00","level":"INFO","message":"service stopped","svc.name":"script-example","svc.version":"v0.1.0","svc.product":"Matrix","svc.language":"rust"}
 ```
 
 For more examples, including how to create new features and new service kind,
 you can check the [examples](examples) directory.
 
 ## Roadmap
 
-* Improve logger to use better structured log system and to set the log level
-using service definitions.
 * Enable features and services to use the same env system that the core uses.
 * Improve unit tests.
 * Full compatibility between go and rust gRPC services.

docs/mikros.md

@@ -142,6 +142,7 @@ as long as they have the same mode of execution (Block/NonBlock)
 Optional fields:
 
 - envs: a string array of required environment variables for the service.
+- log: an object that allows defining the service initial settings for logging.
 
 Additionally, you can use this same file for the following types of definitions:
 
@@ -150,6 +151,8 @@ the application.
 - services: a map of service definitions, to set custom service kind settings
 for the application.
 - clients: a map of client connection definitions, for dependent applications.
+- service: a structure free service definition that the service can use for
+its own settings.
 
 Example:
 
@@ -161,15 +164,22 @@ language = "rust"
 product = "my-awesome-product"
 envs = [ "CUSTOM_ENV_1" ]
 
+# Required settings for the simple_api feature
 [features.simple_api]
 enabled = true
 
+# Custom settings for connecting with the 'grpc' gRPC client
 [clients.grpc]
 host = "localhost"
 port = 7071
 
+# Required settings for the 'cronjob' service type
 [services.cronjob]
 frequency = "daily"
+
+# Custom service settings
+[service]
+max_diff_range = 100
 ```
 
 ### Environment variables

examples/apps/grpc/Cargo.toml

@@ -4,6 +4,7 @@ version = "0.1.0"
 edition = "2021"
 
 [dependencies]
+example = { path = "../../features/example" }
 mikros = { path = "../../../" }
 prost = "0.13.3"
 tokio = { version = "1.41.1", features = ["full"] }

examples/apps/grpc/src/main.rs

@@ -4,7 +4,6 @@ pub mod helloworld {
     include!("generated/helloworld.rs"); // Include generated code
 }
 
-use mikros::features;
 use mikros::service::{builder::ServiceBuilder, context};
 use tonic::{Request, Response, Status};
 
@@ -33,7 +32,7 @@ impl Greeter for MyGreeter {
         ctx.logger()
             .info(format!("the inner value is: {}", self.ctx.lock().await.value).as_str());
 
-        let _ = features::example::execute_on(&ctx, |api| {
+        let _ = example::execute_on(&ctx, |api| {
             api.do_something();
             Ok(())
         })

examples/apps/grpc_with_lifecycle/Cargo.toml

@@ -4,6 +4,7 @@ version = "0.1.0"
 edition = "2021"
 
 [dependencies]
+example = { path = "../../features/example" }
 mikros = { path = "../../../" }
 prost = "0.13.3"
 tokio = { version = "1.41.1", features = ["full"] }

examples/apps/grpc_with_lifecycle/src/main.rs

@@ -5,7 +5,7 @@ pub mod helloworld {
 }
 
 use mikros::service::{builder::ServiceBuilder, context, lifecycle};
-use mikros::{features, link_grpc_service};
+use mikros::link_grpc_service;
 use tonic::transport::Channel;
 use tonic::{Request, Response, Status};
 
@@ -45,7 +45,7 @@ impl Greeter for MyGreeter {
             .say_hello(reply)
             .await?;
 
-        let _ = features::example::execute_on(&ctx, |api| {
+        let _ = example::execute_on(&ctx, |api| {
             api.do_something();
             Ok(())
         })

examples/apps/native/Cargo.toml

@@ -5,6 +5,7 @@ edition = "2021"
 
 [dependencies]
 async-trait = "0.1.83"
+example = { path = "../../features/example" }
 mikros = { path = "../../../" }
 simple_api = { path = "../../features/simple_api" }
 tokio = { version = "1.41.1", features = ["full"] }

examples/apps/native/src/main.rs

@@ -8,7 +8,7 @@ async fn main() {
     let s = AppService::new();
     let svc = ServiceBuilder::default()
         .native(Box::new(s))
-        .with_features(simple_api::features())
+        .with_features(vec![simple_api::new(), example::new()])
         .build();
 
     match svc {

examples/apps/native/src/service.rs

@@ -1,5 +1,4 @@
 use mikros::errors as merrors;
-use mikros::features::example;
 use mikros::service::context::Context;
 
 #[derive(Clone)]

examples/apps/script/Cargo.toml

@@ -5,5 +5,6 @@ edition = "2021"
 
 [dependencies]
 async-trait = "0.1.83"
+example = { path = "../../features/example" }
 mikros = { path = "../../../" }
 tokio = { version = "1.41.1", features = ["full"] }

examples/apps/script/service.toml

@@ -1,5 +1,5 @@
-name = "native-example"
+name = "script-example"
 version = "v0.1.0"
 language = "rust"
-product = "examples"
+product = "Matrix"
 types = ["script"]

examples/apps/script/src/main.rs

@@ -6,7 +6,10 @@ use service::Service as AppService;
 #[tokio::main]
 async fn main() {
     let s = AppService::new();
-    let svc = ServiceBuilder::default().script(Box::new(s)).build();
+    let svc = ServiceBuilder::default()
+        .script(Box::new(s))
+        .with_features(vec![example::new()])
+        .build();
 
     match svc {
         Ok(mut svc) => svc.start().await,

examples/apps/script/src/service.rs

@@ -1,5 +1,4 @@
 use mikros::errors as merrors;
-use mikros::features;
 use mikros::service::context::Context;
 
 #[derive(Clone)]
@@ -28,7 +27,7 @@ impl mikros::service::lifecycle::Lifecycle for Service {
 impl mikros::service::script::ScriptService for Service {
     async fn run(&self, ctx: &Context) -> merrors::Result<()> {
         ctx.logger().info("Start script service");
-        features::example::execute_on(ctx, |api| {
+        example::execute_on(ctx, |api| {
             api.do_something();
             Ok(())
         })

examples/features/example/src/lib.rs

@@ -1,13 +1,9 @@
 use std::any::Any;
-use std::collections::HashMap;
 use std::sync::Arc;
 
-use logger::fields::FieldValue;
-
 use mikros::definition::Definitions;
 use mikros::env::Env;
-use mikros::{errors as merrors, impl_feature_public_api};
-use mikros::{plugin, logger};
+use mikros::{errors as merrors, impl_feature_public_api, plugin, serde_json};
 use mikros::service::context::Context;
 
 /// The feature public API.
@@ -24,10 +20,10 @@ impl plugin::feature::Feature for Example {
         "example"
     }
 
-    fn info(&self) -> HashMap<String, FieldValue> {
-        logger::fields![
-            "test" => FieldValue::String("Hello world".to_string()),
-        ]
+    fn info(&self) -> serde_json::Value {
+        serde_json::json!({
+            "test": "Hello world".to_string(),
+        })
     }
 
     fn is_enabled(&self) -> bool {

examples/features/simple_api/Cargo.toml

@@ -6,4 +6,5 @@ edition = "2021"
 [dependencies]
 async-trait = "0.1.83"
 mikros = { path = "../../../" }
-serde = "1.0.215"
+serde = "1.0.215"
+serde_derive = "1.0.215"

examples/features/simple_api/src/lib.rs

@@ -1,13 +1,11 @@
 use std::any::Any;
-use std::collections::HashMap;
 use std::sync::Arc;
 
 use mikros::env::Env;
-use mikros::{errors as merrors, impl_feature_public_api};
-use mikros::logger;
+use mikros::{errors as merrors, impl_feature_public_api, serde_json};
 use mikros::plugin;
 use mikros::service::context::Context;
-use serde::Deserialize;
+use serde_derive::Deserialize;
 
 /// The feature public API.
 pub trait ExampleAPI {
@@ -60,12 +58,12 @@ impl plugin::feature::Feature for Example {
         Some(self)
     }
 
-    fn info(&self) -> HashMap<String, logger::fields::FieldValue> {
+    fn info(&self) -> serde_json::Value {
         let collections = self.definitions.collections.join(",");
-        logger::fields![
-            "test" => logger::fields::FieldValue::String("Hello world".to_string()),
-            "collections" => logger::fields::FieldValue::String(collections),
-        ]
+        serde_json::json!({
+            "test": "Hello world".to_string(),
+            "collections": collections,
+        })
     }
 
     async fn cleanup(&self) {

examples/services/cronjob/src/lib.rs

@@ -1,12 +1,10 @@
 pub mod builder;
 
-use std::collections::HashMap;
 use std::sync::Arc;
 
 use mikros::definition::ServiceKind;
 use mikros::env::Env;
-use mikros::logger::fields::FieldValue;
-use mikros::{errors as merrors, plugin, Mutex};
+use mikros::{errors as merrors, plugin, Mutex, serde_json};
 use mikros::service::context::Context;
 use mikros::service::lifecycle::Lifecycle;
 use serde_derive::Deserialize;
@@ -46,8 +44,15 @@ impl plugin::service::Service for Cronjob {
         ServiceKind::Custom("cronjob".into())
     }
 
-    fn info(&self) -> HashMap<String, FieldValue> {
-        HashMap::new()
+    fn info(&self) -> serde_json::Value {
+        match self.definitions {
+            Some(ref d) => serde_json::json!({
+                "frequency": d.frequency,
+                "days": d.days,
+                "scheduled_times": d.scheduled_times,
+            }),
+            None => serde_json::json!({}),
+        }
     }
 
     fn initialize(&mut self, _envs: Arc<Env>, definitions: Arc<mikros::definition::Definitions>) -> merrors::Result<()> {

src/definition/mod.rs

@@ -33,9 +33,19 @@ pub struct Definitions {
     pub types: Vec<service::Service>,
 }
 
-#[derive(serde_derive::Deserialize, Debug)]
+#[derive(serde_derive::Deserialize, Debug, Clone)]
 pub struct Log {
-    pub level: String
+    pub level: String,
+    pub local_timestamp: bool,
+}
+
+impl Default for Log {
+    fn default() -> Self {
+        Log {
+            level: "info".to_string(),
+            local_timestamp: true,
+        }
+    }
 }
 
 #[derive(serde_derive::Deserialize, Debug, Clone)]
@@ -133,6 +143,13 @@ impl Definitions {
         }
     }
 
+    pub(crate) fn log(&self) -> Log {
+        match &self.log {
+            Some(l) => l.clone(),
+            None => Log::default()
+        }
+    }
+
     /// Loads definitions from a feature.
     pub fn load_feature<T>(&self, feature: &str) -> merrors::Result<Option<T>>
     where

src/definition/service.rs

@@ -1,4 +1,5 @@
 use std::fmt::Formatter;
+
 use serde::de::{Deserializer, Visitor, Error as SerdeError};
 use serde::{Deserialize, de::IntoDeserializer};
 
@@ -7,7 +8,7 @@ use crate::definition::ServiceKind;
 #[derive(Debug, Clone)]
 pub struct Service(pub ServiceKind, pub Option<i32>);
 
-impl<'a> serde::Deserialize<'a> for Service {
+impl<'a> Deserialize<'a> for Service {
     fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
     where
         D: Deserializer<'a>
@@ -66,7 +67,7 @@ mod tests {
     use super::*;
 
     // Wrapper struct to deserialize from TOML
-    #[derive(Debug, Deserialize)]
+    #[derive(Debug, serde_derive::Deserialize)]
     struct Config {
         #[serde(deserialize_with = "deserialize_services")]
         types: Vec<Service>,

src/lib.rs

@@ -2,6 +2,7 @@ pub mod definition;
 pub mod env;
 pub mod errors;
 pub mod http;
+pub mod logger;
 pub mod plugin;
 pub mod service;
 
@@ -10,5 +11,5 @@ mod grpc;
 
 // Forward some declarations for services
 pub use futures::lock::Mutex;
-pub use logger;
 pub use tokio::sync::watch;
+pub use serde_json;