Tracing

templates/Readme.md

@@ -8,3 +8,17 @@ Open the documentation with the following command:
 ``` 
     cargo doc --no-deps --open
 ```
+
+## Tracing
+The generated microservice uses OpenTelemetry for tracing. Each handler function is wrapped in a span, which can be modified to fit your tracing needs. 
+
+The default exporter is the Jaeger exporter. The default configuration is set to export to a Jaeger instance running on `localhost:6831`.
+
+Jaeger can be started in Docker using the following command:
+```
+docker run -d -p6831:6831/udp -p6832:6832/udp -p16686:16686 -p14268:14268 jaegertracing/all-in-one:latest
+```
+
+Access the Jaeger UI at http://localhost:16686 and look for your service name in the dropdown menu.
+
+For more information, visit the [Jaeger website](https://www.jaegertracing.io/docs/getting-started/).

templates/dependencies.toml

@@ -5,4 +5,5 @@ serde_json = "1.0.97"
 tokio = { version = "1.28.2", features = ["full"] }
 dotenv = "0.15.0"
 clap = {version = "4.3.0", features = ["derive"]}
-
+opentelemetry = { version = "*", features = ["rt-tokio"] }
+opentelemetry-jaeger = { version = "*", features = ["rt-tokio", "isahc_collector_client"] }

templates/src/handler.go

@@ -2,7 +2,8 @@ use async_nats::{Client, Message, jetstream};
 use async_nats::jetstream::Context;
 use crate::{publish_message,stream_publish_message,model::*,config::*};
 use std::time;
-
+use opentelemetry::global;
+use opentelemetry::trace::Tracer;
 
 
 {{ range .publish_channels  }}
@@ -18,6 +19,8 @@ use std::time;
     {{end}}
     {{if $isStream}}
         pub fn stream_handler_{{ (index . 1).unique_id }}(message: jetstream::Message, client: &Client) {
+            let tracer = global::tracer("stream_handler_{{ (index . 1).unique_id }}");
+            let _span = tracer.start("{{ (index . 1).unique_id }}_stream_handler");
             {{ range (index . 1).messages }}
                 {{ if .payload}}
                     match serde_json::from_slice::<{{ .payload.struct_reference }}>(&message.message.payload.as_ref()) {
@@ -46,6 +49,8 @@ use std::time;
         }
     {{else}}
         pub async fn handler_{{ (index . 1).unique_id }}(message: Message, client: &Client) {
+            let tracer = global::tracer("handler_{{ (index . 1).unique_id }}");
+            let _span = tracer.start("{{ (index . 1).unique_id }}_handler");
             {{ range (index . 1).messages }}
                 {{ if .payload}}
                 match serde_json::from_slice::<{{ .payload.struct_reference }}>(&message.payload.as_ref()) {
@@ -93,6 +98,8 @@ use std::time;
     {{ if $isStream }}
         {{ range (index . 1).messages }}
             pub async fn stream_producer_{{ (index $channel 1).unique_id }}(context_stream: &Context, payload : {{ if .payload}} {{ .payload.struct_reference }} {{ else }} () {{ end }}) { //context instead of client
+                let tracer = global::tracer("{{ (index $channel 1).unique_id }}_stream_producer");
+                let _span = tracer.start("stream_producer_{{ (index $channel 1).unique_id }}");
                 let subject = get_env().get("{{ (index $channel 1).unique_id }}_SUBJECT").unwrap().clone();
                 {{ if .payload }}
                     let payload = match serde_json::to_string(&payload) {
@@ -111,6 +118,8 @@ use std::time;
     {{ else }}
         {{ range (index . 1).messages }}
             pub async fn producer_{{ (index $channel 1).unique_id }}(client: &Client, payload: {{ if .payload }} {{.payload.struct_reference}} {{else}} () {{end}}) {
+                let tracer = global::tracer("{{ (index $channel 1).unique_id }}_producer");
+                let _span = tracer.start("producer_{{ (index $channel 1).unique_id }}");
                 let subject = get_env().get("{{ (index $channel 1).unique_id }}_SUBJECT").unwrap().clone();
                 {{ if .payload }}
                     let payload = match serde_json::to_string(&payload) {

templates/src/main.go

@@ -10,10 +10,19 @@ use async_nats::jetstream::{self};
 use std::{collections::HashMap};
 use dotenv::dotenv;
 mod config;
+use opentelemetry::global;
+use opentelemetry::trace::Tracer;
 
 
 #[tokio::main]
 async fn main() -> Result<(), async_nats::Error> {
+    // Initialize Jaeger Tracer
+    global::set_text_map_propagator(opentelemetry_jaeger::Propagator::new());
+    let tracer = opentelemetry_jaeger::new_agent_pipeline()
+    .with_service_name("{{ .title}}")
+        .install_batch(opentelemetry::runtime::Tokio)
+        .expect("Failed to initialize Jaeger Tracer");
+
     let env: HashMap<String,String> = config::get_env();
     let args = cli::Args::parse();
 
@@ -56,7 +65,7 @@ async fn main() -> Result<(), async_nats::Error> {
         {{ end }}
     {{ end }}
     );
-
+    opentelemetry::global::shutdown_tracer_provider();
     println!("fin");
     Ok(())
 }