OpenTelemetry tracing

Author: adamw

README.md

@@ -8,12 +8,12 @@
 
 ### Using Docker compose
 
-The fastest way to experiment with Bootzooka is using the provided Docker compose setup. It starts three images: 
+The fastest way to experiment with Bootzooka is using the provided Docker compose setup. It starts three images:
 Bootzooka itself (either locally built or downloaded), PostgreSQL server and Graphana LGTM for observability.
 
 ### Backend: PostgreSQL & API
 
-To run Bootzooka's backend locally, you'll still need a running instance of PostgreSQL with a `bootzooka` database. 
+To run Bootzooka's backend locally, you'll still need a running instance of PostgreSQL with a `bootzooka` database.
 You can spin up one easily using docker:
 
 ```sh
@@ -44,12 +44,12 @@ Then, you can start the frontend:
 ./frontend-start.sh
 ```
 
-And open `http://localhost:3000`.
+And open `http://localhost:8081`.
 
 ## Commercial Support
 
 We offer commercial support for Bootzooka and related technologies, as well as development services. [Contact us](https://softwaremill.com) to learn more about our offer!
 
 ## Copyright
 
-Copyright (C) 2013-2024 SoftwareMill [https://softwaremill.com](https://softwaremill.com).
+Copyright (C) 2013-2025 SoftwareMill [https://softwaremill.com](https://softwaremill.com).

backend/src/main/resources/application.conf

@@ -88,7 +88,7 @@ email {
 }
 
 password-reset {
-  reset-link-pattern = "http://localhost:3000/password-reset?code=%s"
+  reset-link-pattern = "http://localhost:8081/password-reset?code=%s"
   reset-link-pattern = ${?PASSWORD_RESET_LINK_PATTERN}
 
   code-valid = 1 day

backend/src/main/scala/com/softwaremill/bootzooka/Main.scala

@@ -4,21 +4,28 @@ import com.softwaremill.bootzooka.logging.Logging
 import ox.logback.InheritableMDC
 import ox.{Ox, OxApp, never}
 import org.slf4j.bridge.SLF4JBridgeHandler
+import ox.OxApp.Settings
+import ox.otel.context.PropagatingVirtualThreadFactory
 
 object Main extends OxApp.Simple with Logging:
-  // route JUL to SLF4J
+  // route JUL to SLF4J (JUL is used by Magnum for logging)
   SLF4JBridgeHandler.removeHandlersForRootLogger()
   SLF4JBridgeHandler.install()
 
+  // https://ox.softwaremill.com/latest/integrations/mdc-logback.html
   InheritableMDC.init
+
   Thread.setDefaultUncaughtExceptionHandler((t, e) => logger.error("Uncaught exception in thread: " + t, e))
 
+  // https://ox.softwaremill.com/latest/integrations/otel-context.html
+  override protected def settings: Settings = Settings.Default.copy(threadFactory = PropagatingVirtualThreadFactory())
+
   override def run(using Ox): Unit =
     val deps = Dependencies.create
 
     deps.emailService.startProcesses()
-    val binding = deps.httpApi.start()
-    logger.info(s"Started Bootzooka on ${binding.hostName}:${binding.port}.")
+    deps.httpApi.start()
+    logger.info(s"Bootzooka started")
 
     // blocking until the application is shut down
     never

backend/src/main/scala/com/softwaremill/bootzooka/http/HttpApi.scala

@@ -14,6 +14,7 @@ import sttp.tapir.server.metrics.opentelemetry.OpenTelemetryMetrics
 import sttp.tapir.server.model.ValuedEndpointOutput
 import sttp.tapir.server.netty.NettyConfig
 import sttp.tapir.server.netty.sync.{NettySyncServer, NettySyncServerBinding, NettySyncServerOptions}
+import sttp.tapir.server.tracing.opentelemetry.OpenTelemetryTracing
 import sttp.tapir.swagger.SwaggerUIOptions
 import sttp.tapir.swagger.bundle.SwaggerInterpreter
 
@@ -40,6 +41,7 @@ class HttpApi(
 
   private val serverOptions: NettySyncServerOptions = NettySyncServerOptions.customiseInterceptors
     .prependInterceptor(CorrelationIdInterceptor)
+    .prependInterceptor(OpenTelemetryTracing(otel))
     // all errors are formatted as JSON, and no additional routes are added to the server
     .defaultHandlers(msg => ValuedEndpointOutput(Http.jsonErrorOutOutput, Error_OUT(msg)), notFoundWhenRejected = true)
     .corsInterceptor(CORSInterceptor.default[Identity])

backend/src/main/scala/com/softwaremill/bootzooka/infrastructure/CorrelationId.scala

@@ -4,7 +4,6 @@ import com.softwaremill.bootzooka.logging.Logging
 import org.slf4j.MDC
 import ox.logback.InheritableMDC
 import sttp.client3.*
-import sttp.client3.{Response, SttpBackend}
 import sttp.capabilities.Effect
 import sttp.monad.MonadError
 import sttp.tapir.server.interceptor.{EndpointInterceptor, RequestHandler, RequestInterceptor, Responder}

backend/src/main/scala/com/softwaremill/bootzooka/passwordreset/PasswordResetApi.scala

@@ -3,7 +3,6 @@ package com.softwaremill.bootzooka.passwordreset
 import com.github.plokhotnyuk.jsoniter_scala.macros.ConfiguredJsonValueCodec
 import com.softwaremill.bootzooka.http.Http.*
 import com.softwaremill.bootzooka.infrastructure.DB
-import com.softwaremill.bootzooka.infrastructure.Magnum.*
 import com.softwaremill.bootzooka.http.{EndpointsForDocs, ServerEndpoints}
 import sttp.tapir.Schema
 

backend/src/main/scala/com/softwaremill/bootzooka/user/UserApi.scala

@@ -4,13 +4,11 @@ import com.github.plokhotnyuk.jsoniter_scala.macros.ConfiguredJsonValueCodec
 import com.softwaremill.bootzooka.Fail
 import com.softwaremill.bootzooka.http.Http.*
 import com.softwaremill.bootzooka.infrastructure.DB
-import com.softwaremill.bootzooka.infrastructure.Magnum.*
 import com.softwaremill.bootzooka.metrics.Metrics
 import com.softwaremill.bootzooka.security.{ApiKey, Auth}
 import com.softwaremill.bootzooka.http.{EndpointsForDocs, ServerEndpoints}
 import com.softwaremill.bootzooka.util.Strings.{Id, asId}
 import sttp.tapir.*
-import sttp.tapir.json.jsoniter.jsonBody
 
 import java.time.Instant
 import scala.concurrent.duration.*

build.sbt

@@ -34,6 +34,8 @@ val httpDependencies = Seq(
 val observabilityDependencies = Seq(
   "com.softwaremill.sttp.client3" %% "opentelemetry-metrics-backend" % sttpVersion,
   "com.softwaremill.sttp.tapir" %% "tapir-opentelemetry-metrics" % tapirVersion,
+  "com.softwaremill.sttp.tapir" %% "tapir-opentelemetry-tracing" % tapirVersion,
+  "com.softwaremill.ox" %% "otel-context" % oxVersion,
   "io.opentelemetry" % "opentelemetry-exporter-otlp" % otelVersion,
   "io.opentelemetry" % "opentelemetry-sdk-extension-autoconfigure" % otelVersion,
   "io.opentelemetry.instrumentation" % "opentelemetry-runtime-telemetry-java8" % otelInstrumentationVersion,
@@ -182,35 +184,33 @@ lazy val backend: Project = (project in file("backend"))
       configDependencies ++ dbDependencies ++ httpDependencies ++ jsonDependencies ++
       apiDocsDependencies ++ observabilityDependencies ++ securityDependencies ++ emailDependencies,
     Compile / mainClass := Some("com.softwaremill.bootzooka.Main"),
-    copyWebapp := {
-      val source = uiDirectory.value / "build"
-      val target = (Compile / classDirectory).value / "webapp"
-      streams.value.log.info(s"Copying the webapp resources from $source to $target")
-      IO.copyDirectory(source, target)
-    },
-    copyWebapp := copyWebapp
-      .dependsOn(
-        Def
-          .sequential(
-            generateOpenAPIDescription,
-            yarnTask.toTask(" build")
-          )
-      )
-      .value,
+    // generates the target/openapi.yaml file which is then used by the UI to generate service stubs
     generateOpenAPIDescription := Def.taskDyn {
       val log = streams.value.log
       val targetPath = ((Compile / target).value / "openapi.yaml").toString
       Def.task {
         (Compile / runMain).toTask(s" com.softwaremill.bootzooka.writeOpenAPIDescription $targetPath").value
       }
     }.value,
+    // used by fat-jar and docker builds, to copy the UI files to a single bundle
+    copyWebapp := {
+      val source = uiDirectory.value / "build"
+      val target = (Compile / classDirectory).value / "webapp"
+      streams.value.log.info(s"Copying the webapp resources from $source to $target")
+      IO.copyDirectory(source, target)
+    },
+    copyWebapp := copyWebapp.dependsOn(Def.sequential(generateOpenAPIDescription, yarnTask.toTask(" build"))).value,
+    // used by backend-start.sh, to restart the application when sources change
+    reStart := {
+      generateOpenAPIDescription.value
+      reStart.evaluated
+    },
     // needed so that a ctrl+c issued when running the backend from the sbt console properly interrupts the application
     run / fork := true,
     scalacOptions ++= List("-Wunused:all", "-Wvalue-discard")
   )
   .enablePlugins(BuildInfoPlugin)
   .settings(commonSettings)
-  .settings(Revolver.settings)
   .settings(buildInfoSettings)
   .settings(fatJarSettings)
   .enablePlugins(DockerPlugin)

docker-compose.yml

@@ -14,7 +14,7 @@ services:
       API_HOST: '0.0.0.0'
       OTEL_EXPORTER_OTLP_ENDPOINT: 'http://observability:4317'
       OTEL_SERVICE_NAME: 'bootzooka'
-      OTEL_METRIC_EXPORT_INTERVAL: '500' # The default is 60s, in development it's useful to see the metrics faster 
+      OTEL_METRIC_EXPORT_INTERVAL: '500' # The default is 60s, in development it's useful to see the metrics faster
       OTEL_RESOURCE_ATTRIBUTES: 'service.instance.id=local,service.version=latest'
 
   bootzooka-db:
@@ -31,3 +31,4 @@ services:
     image: 'grafana/otel-lgtm'
     ports:
       - '3000:3000' # Grafana's UI
+      - '4317:4317' # Exporter

docs/frontend.md

@@ -21,7 +21,7 @@ If this is your first attempt to run `ui`, please go to `ui` project and run
 
     yarn install
 
-This will install all required dependencies for this project. If all is well you can start your development version of frontend by issuing `yarn start` from command line (or running the provided `frontend-start` script in the main directory). It should start your browser and point you to [Bootzooka home page](http://0.0.0.0:3000/#/).
+This will install all required dependencies for this project. If all is well you can start your development version of frontend by issuing `yarn start` from command line (or running the provided `frontend-start` script in the main directory). It should start your browser and point you to [Bootzooka home page](http://0.0.0.0:8081/#/).
 
 ## Development
 
@@ -36,7 +36,7 @@ The most important tasks exposed are:
 
 ## `yarn start` task
 
-This task serves Bootzooka application on port `3000` on `0.0.0.0` (it is available to all hosts from the same network). Your default browser should open at this location. All requests to the backend will be proxied to port `8080` where it expects the server to be run.
+This task serves Bootzooka application on port `8081` on `0.0.0.0` (it is available to all hosts from the same network). Your default browser should open at this location. All requests to the backend will be proxied to port `8080` where it expects the server to be run.
 
 Hot reload is in place already (provided by the Vite stack), so every change is automatically compiled (if necessary) and browser is automatically refreshed to apply changes. No need to refresh it by hand.