Grafana LGTM in docker compose

Author: adamw

.scalafix.conf

@@ -0,0 +1,2 @@
+OrganizeImports.groupedImports = AggressiveMerge
+OrganizeImports.targetDialect = Scala3

README.md

@@ -6,10 +6,15 @@
 
 ## Quick start
 
+### Using Docker compose
+
+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
 
-In order to run Bootzooka, you'll need a running instance of PostgreSQL with a `bootzooka` database. You can spin
-up one easily using docker:
+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
 # use "bootzooka" as a password

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

@@ -2,21 +2,18 @@ package com.softwaremill.bootzooka
 
 import com.softwaremill.bootzooka.admin.VersionApi
 import com.softwaremill.bootzooka.config.Config
-import com.softwaremill.bootzooka.email.sender.EmailSender
 import com.softwaremill.bootzooka.email.EmailService
+import com.softwaremill.bootzooka.email.sender.EmailSender
 import com.softwaremill.bootzooka.http.{HttpApi, HttpConfig}
 import com.softwaremill.bootzooka.infrastructure.{DB, SetCorrelationIdBackend}
 import com.softwaremill.bootzooka.metrics.Metrics
-import com.softwaremill.bootzooka.passwordreset.{PasswordResetAuthToken, PasswordResetApi}
+import com.softwaremill.bootzooka.passwordreset.{PasswordResetApi, PasswordResetAuthToken}
 import com.softwaremill.bootzooka.security.{ApiKeyAuthToken, ApiKeyService, Auth}
 import com.softwaremill.bootzooka.user.UserApi
 import com.softwaremill.bootzooka.util.{Clock, DefaultClock, DefaultIdGenerator, IdGenerator}
 import com.softwaremill.macwire.{autowire, autowireMembersOf}
 import io.opentelemetry.api.OpenTelemetry
-import io.opentelemetry.exporter.otlp.metrics.OtlpGrpcMetricExporter
-import io.opentelemetry.sdk.OpenTelemetrySdk
-import io.opentelemetry.sdk.metrics.SdkMeterProvider
-import io.opentelemetry.sdk.metrics.`export`.PeriodicMetricReader
+import io.opentelemetry.sdk.autoconfigure.AutoConfiguredOpenTelemetrySdk
 import ox.{IO, Ox, tap, useCloseableInScope, useInScope}
 import sttp.client3.logging.slf4j.Slf4jLoggingBackend
 import sttp.client3.opentelemetry.OpenTelemetryMetricsBackend
@@ -34,7 +31,7 @@ object Dependencies:
 
   def create(using Ox, IO): Dependencies =
     val config = Config.read.tap(Config.log)
-    val otel = createOtel()
+    val otel = AutoConfiguredOpenTelemetrySdk.initialize().getOpenTelemetrySdk()
     val sttpBackend = useInScope(
       Slf4jLoggingBackend(OpenTelemetryMetricsBackend(new SetCorrelationIdBackend(HttpClientSyncBackend()), otel), includeTiming = true)
     )(_.close())
@@ -58,13 +55,3 @@ object Dependencies:
       new Auth(_: ApiKeyAuthToken, _: DB, _: Clock),
       new Auth(_: PasswordResetAuthToken, _: DB, _: Clock)
     )
-
-  private def createOtel(): OpenTelemetry =
-    // An exporter that sends metrics to a collector over gRPC
-    val grpcExporter = OtlpGrpcMetricExporter.builder().build()
-    // A metric reader that exports using the gRPC exporter
-    val metricReader: PeriodicMetricReader = PeriodicMetricReader.builder(grpcExporter).build()
-    // A meter registry whose meters are read by the above reader
-    val meterProvider: SdkMeterProvider = SdkMeterProvider.builder().registerMetricReader(metricReader).build()
-    // An instance of OpenTelemetry using the above meter registry
-    OpenTelemetrySdk.builder().setMeterProvider(meterProvider).build()

build.sbt

@@ -13,6 +13,7 @@ val password4jVersion = "1.8.2"
 val sttpVersion = "3.9.8"
 val tapirVersion = "1.11.4"
 val oxVersion = "0.3.8"
+val otelVersion = "1.42.1"
 
 val dbDependencies = Seq(
   "com.augustnagro" %% "magnum" % "1.2.1",
@@ -29,10 +30,11 @@ val httpDependencies = Seq(
   "com.softwaremill.sttp.tapir" %% "tapir-files" % tapirVersion
 )
 
-val monitoringDependencies = Seq(
+val observabilityDependencies = Seq(
   "com.softwaremill.sttp.client3" %% "opentelemetry-metrics-backend" % sttpVersion,
   "com.softwaremill.sttp.tapir" %% "tapir-opentelemetry-metrics" % tapirVersion,
-  "io.opentelemetry" % "opentelemetry-exporter-otlp" % "1.42.1"
+  "io.opentelemetry" % "opentelemetry-exporter-otlp" % otelVersion,
+  "io.opentelemetry" % "opentelemetry-sdk-extension-autoconfigure" % otelVersion
 )
 
 val jsonDependencies = Seq(
@@ -174,7 +176,7 @@ lazy val backend: Project = (project in file("backend"))
   .settings(
     libraryDependencies ++= baseDependencies ++ testingDependencies ++ loggingDependencies ++
       configDependencies ++ dbDependencies ++ httpDependencies ++ jsonDependencies ++
-      apiDocsDependencies ++ monitoringDependencies ++ securityDependencies ++ emailDependencies,
+      apiDocsDependencies ++ observabilityDependencies ++ securityDependencies ++ emailDependencies,
     Compile / mainClass := Some("com.softwaremill.bootzooka.Main"),
     copyWebapp := {
       val source = uiDirectory.value / "build"

docker-compose.yml

@@ -1,4 +1,3 @@
-version: '3'
 services:
   bootzooka:
     image: 'softwaremill/bootzooka:latest'
@@ -13,6 +12,9 @@ services:
       SQL_HOST: 'bootzooka-db'
       SQL_PORT: '5432'
       API_HOST: '0.0.0.0'
+      OTEL_EXPORTER_OTLP_ENDPOINT: 'http://observability:4317'
+      OTEL_SERVICE_NAME: 'bootzooka'
+
   bootzooka-db:
     image: 'postgres'
     ports:
@@ -21,3 +23,9 @@ services:
       POSTGRES_USER: 'postgres'
       POSTGRES_PASSWORD: 'b00t200k4'
       POSTGRES_DB: 'bootzooka'
+
+  # OpenTelemetry Collector, Prometheus, Loki, Tempo, Grafana
+  observability:
+    image: 'grafana/otel-lgtm'
+    ports:
+      - '3000:3000' # Grafana's UI

docs/production.md

@@ -13,7 +13,7 @@ java -jar backend/target/scala-VERSION/bootzooka.jar
 
 ## Docker
 
-To build a docker image, run `backend/docker:publishLocal`. This will create the `docker:latest` image.
+To build a docker image, run `backend/Docker/publishLocal`. This will create the `docker:latest` image.
 
 You can test the image by using the provided `docker-compose.yml` file.