Merge pull request #81 from OneLiteFeatherNET/feat/opentelemetry

Feat/opentelemetry

.dockerignore

@@ -6,3 +6,4 @@ common/target/
 codegen/target/
 tests/
 docs/
+Makefile.toml

Cargo.toml

@@ -28,6 +28,11 @@ notify = { version = "6.1.1", default-features = false, features = [
   "macos_kqueue",
 ] }
 openidconnect = "3.5.0"
+opentelemetry = { version = "0.23.0", optional = true }
+opentelemetry_sdk = { version = "0.23.0", optional = true, features = ["rt-tokio"] }
+opentelemetry-otlp = { version = "0.16.0", optional = true }
+opentelemetry-semantic-conventions = { version = "0.15.0", optional = true }
+opentelemetry-http = { version = "0.12.0", optional = true }
 paste = "1.0.14"
 prost-types = "0.12.4"
 rbatis = "4.5.21"
@@ -49,6 +54,7 @@ tower = "0.4.13"
 tokio-retry = "0.3"
 tower-http = { version = "=0.4.4", features = ["trace", "validate-request"] }
 tracing = "0.1.39"
+tracing-opentelemetry = { version = "0.24.0", optional = true }
 tracing-subscriber = { version = "0.3.18", features = ["env-filter"] }
 typed-builder = "0.18.1"
 validator = { version = "0.18", features = ["derive"] }
@@ -61,8 +67,16 @@ reqwest = { version = "0.12.3", features = ["json"] }
 test-log = "0.2.15"
 
 [features]
-default = ["all-databases"]
+default = ["all-databases", "otlp"]
 
+otlp = [
+  "opentelemetry",
+  "opentelemetry-otlp",
+  "opentelemetry-semantic-conventions",
+  "opentelemetry_sdk",
+  "opentelemetry-http", 
+  "tracing-opentelemetry"
+]
 all-databases = ["postgres", "mysql", "mssql"]
 postgres = ["rbdc-pg"]
 mysql = ["rbdc-mysql"]

Dockerfile

@@ -1,6 +1,6 @@
 FROM rust:slim as build
 
-ARG features=all-databases
+ARG features=all-databases,otlp
 
 COPY ./Cargo.toml . 
 COPY ./Cargo.lock . 

docs/.vitepress/config.ts

@@ -17,9 +17,17 @@ export default defineConfig({
         text: "Docs",
         items: [
           { text: "Configuration", link: "/docs/configuration" },
-          { text: "Deployment", items: [
+          {
+            text: "Deployment", items: [
               { text: "Helm", link: "/docs/deployment/helm" },
-              { text: "Docker", link: "/docs/deployment/docker" }
+              { text: "Docker", link: "/docs/deployment/docker" },
+              { text: "Verify deployment", link: "/docs/deployment/verify" }
+            ]
+          },
+          {
+            text: "Observability", items: [
+              { text: "Logging", link: "/docs/observability/logging" },
+              { text: "Tracing", link: "/docs/observability/tracing" }
             ]
           },
           {

docs/docs/configuration.md

@@ -11,7 +11,9 @@ You can set the following environment variables:
 | `OIDC_AUDIENCE`         | `String`          | `"feedback-fusion"`        | The audience for the OIDC tokens.                                           |
 | `OIDC_ISSUER`           | `Option<String>`  | `None`                     | The optional issuer URL for the OIDC tokens.                                |
 | `CONFIG_PATH`           | `Option<String>`  | `None`                     | The optional path to the configuration file. (Not Required using the helm chart) |
-| `RUST_LOG`              | `String`          | `None`                     | The log level for the application. [Possible values](https://docs.rs/log/latest/log/enum.Level.html) |   
+| `RUST_LOG`              | `String`          | `None`                     | The log level for the application. [Possible values](https://docs.rs/log/latest/log/enum.Level.html) | 
+| `OTLP_ENDPOINT`         | `Option<String>`  | `None`                     | The gRPC OTLP endpoint to send the trace spans to                           |
+| `SERVICE_NAME`          | `String`          | `"feedback-fusion"`        | Service name used in tracing context                                        |
 
 ## Database Configuration
 

docs/docs/deployment/verify.md

@@ -0,0 +1,20 @@
+# Verify the deployment
+
+To verify and test the deployment of FeedbackFusion, you can run the integration tests. The following prerequisites and instructions will guide you through the process.
+
+## Prerequisites
+
+- **Rust** installed on your machine.
+- **cargo-make** installed. You can install it using the following command:
+  ```sh
+  cargo install cargo-make
+  ```
+- The FeedbackFusion application must be accessible on port 8000 on the machine where the tests are executed. This can be achieved via port-forwarding if using Kubernetes.
+- Override the `OIDC_PROVIDER`, `CLIENT_ID` and `CLIENT_SECRET` in the Makefile.
+
+## Running Integration Tests
+
+To run the integration tests, execute the following command:
+
+```sh
+cargo make integration_test

docs/docs/observability/logging.md

@@ -0,0 +1,11 @@
+# Logging 
+
+FeedbackFusion uses the `RUST_LOG` environment variable to control the default logging level of the process. The following table lists the possible values for `RUST_LOG` and describes what each level typically outputs.
+
+| Level   | Description                                                                                       |
+|---------|---------------------------------------------------------------------------------------------------|
+| ERROR   | Logs only error messages.                                                                         |
+| WARN    | Logs warnings and error messages.                                                                 |
+| INFO    | Logs informational messages, warnings, and error messages.                                        |
+| DEBUG   | Logs debug information, including database requests, informational messages, warnings, and errors.|
+| TRACE   | Logs everything, including trace-level information, debug information, database requests, informational messages, warnings, and errors. |

docs/docs/observability/tracing.md

@@ -0,0 +1,15 @@
+
+# Distributed Tracing
+
+FeedbackFusion supports distributed tracing using the OpenTelemetry Protocol (OTLP) utilizing the `HeaderExtractor` in order 
+to resolve trace parents.
+
+For more information regarding the documentation checkout the [Configuration](/docs/configuration)
+
+## Example with Jaeger
+
+To configure FeedbackFusion to use Jaeger for distributed tracing, you need to set the `OTLP_ENDPOINT` to Jaeger's default OTLP port:
+
+```sh
+OTLP_ENDPOINT=http://jaeger:4317
+```

src/config.rs

@@ -44,6 +44,9 @@ pub struct Config {
     oidc_audience: String,
     oidc_issuer: Option<String>,
     config_path: Option<String>,
+    otlp_endpoint: Option<String>,
+    #[serde(default = "default_service_name")]
+    service_name: String
 }
 
 #[inline]
@@ -56,6 +59,11 @@ fn default_oidc_audience() -> String {
     "feedback-fusion".to_owned()
 }
 
+#[inline]
+fn default_service_name() -> String {
+    "feedback-fusion".to_owned()
+}
+
 #[derive(Debug, Clone, Deserialize, Serialize, PartialEq)]
 pub struct InstanceConfig {
     targets: Vec<TargetConfig>,

src/database/mod.rs

@@ -183,15 +183,14 @@ database_configuration!(
 
 #[macro_export]
 macro_rules! database_request {
-    ($expr: expr) => {{
-        let span = info_span!("Database Request");
-        let _ = span.enter();
-        $expr
-    }};
     ($expr: expr, $title: expr) => {{
-        let span = info_span!(concat!("Database Request: ", $title));
-        let _ = span.enter();
-        $expr
+        let span = info_span!(concat!("Database request: ", $title));
+
+        async  {
+            $expr
+        }
+        .instrument(span)
+        .await
     }};
 }