Generate OpenAPI spec during compile

.github/workflows/bootzooka-ci.yml

@@ -11,8 +11,6 @@ on:
  release:
  types:
  - released
- paths-ignore:
- - "helm/**"
 
 jobs:
  verify:
@@ -21,23 +19,18 @@ jobs:
  steps:
  - name: Check-out repository
  id: repo-checkout
- uses: actions/checkout@v2
+ uses: actions/checkout@v4
 
- - name: Set up JDK 21
- id: jdk-setup
- uses: actions/setup-java@v1
+ - name: Set up JDK
+ uses: actions/setup-java@v4
  with:
- java-version: 21
+ distribution: 'zulu'
+ java-version: '21'
+ cache: 'sbt'
 
- - name: Cache SBT
- id: cache-sbt
- uses: actions/cache@v2
- with:
- path: |
- ~/.sbt
- ~/.ivy2/cache
- ~/.coursier
- key: ${{ runner.os }}-sbt-${{ hashFiles('**/build.sbt') }}
+ - name: Generate OpenAPI Spec
+ id: generate-openapi-spec
+ run: sbt "backend/generateOpenAPIDescription"
 
  - name: Run tests
  id: run-tests
@@ -56,33 +49,26 @@ jobs:
  steps:
  - name: Check-out repository
  id: repo-checkout
- uses: actions/checkout@v2
+ uses: actions/checkout@v4
 
- - name: Set up JDK 21
- id: jdk-setup
- uses: actions/setup-java@v1
+ - name: Set up JDK
+ uses: actions/setup-java@v4
  with:
- java-version: 21
-
- - name: Cache SBT
- id: cache-sbt
- uses: actions/cache@v2
- with:
- path: |
- ~/.sbt
- ~/.ivy2/cache
- ~/.coursier
- key: ${{ runner.os }}-sbt-${{ hashFiles('**/build.sbt') }}
+ distribution: 'zulu'
+ java-version: '21'
+ cache: 'sbt'
 
  - name: Login to DockerHub
  uses: docker/login-action@v1
  with:
  username: ${{ secrets.DOCKERHUB_USERNAME }}
  password: ${{ secrets.DOCKERHUB_TOKEN }}
+
  - name: Extract version
  run: |
  version=${GITHUB_REF/refs\/tags\/v/}
  echo "VERSION=$version" >> $GITHUB_ENV
+
  - name: Publish release notes
  uses: release-drafter/release-drafter@v5
  with:
@@ -93,5 +79,6 @@ jobs:
  version: "v${{ env.VERSION }}"
  env:
  GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
  - name: Publish docker image
  run: sbt backend/docker:publish

.gitignore

@@ -1,11 +1,41 @@
+# See https://help.github.com/articles/ignoring-files/ for more about ignoring files.
+
+# dependencies
+node_modules
+.pnp
+.pnp.js
+
+# testing
+/coverage
+
+# production
+build
+target
+
+# misc
+.DS_Store
+.env.local
+.env.development.local
+.env.test.local
+.env.production.local
+
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+
+*.log
+work.txt
+
+# generated code
+/ui/src/api-client/openapi.d.ts
+
+# IDE
 *.iml
 *.ipr
 *.iws
 .idea/
-target/
-*.log
-.DS_Store
-data/
 *.bloop
 *.metals
-.bsp
+.vscode
+metals.sbt
+.bsp

.scala-steward.conf

@@ -1,5 +0,0 @@
-updates.ignore = [
- {groupId = "org.scala-lang", artifactId = "scala-compiler", version = "2.12."},
- {groupId = "org.scala-lang", artifactId = "scala-compiler", version = "2.13."},
- {groupId = "org.scala-lang", artifactId = "scala-compiler", version = "3."}
-]

.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/resources/application.conf

@@ -28,8 +28,6 @@ db {
  migrate-on-start = ${?MIGRATE_ON_START}
 
  driver = "org.postgresql.Driver"
-
- connect-thread-pool-size = 32
 }
 
 email {

backend/src/main/resources/jmx/rules/jvm.yaml

@@ -0,0 +1,78 @@
+---
+# based on: https://github.com/open-telemetry/opentelemetry-java-contrib/blob/main/jmx-metrics/src/main/resources/target-systems/jvm.groovy
+# TODO: if https://github.com/open-telemetry/opentelemetry-java-instrumentation/pull/12310 gets merged, remove and replace
+rules:
+ - bean: java.lang:type=ClassLoading
+ prefix: jvm.classes.loaded.
+ mapping:
+ LoadedClassCount:
+ metric: count
+ type: updowncounter
+ unit: "{class}"
+ desc: number of loaded classes
+
+ - bean: java.lang:type=GarbageCollector,*
+ prefix: jvm.gc.collections.
+ metricAttribute:
+ name: param(name)
+ mapping:
+ CollectionCount:
+ metric: count
+ type: updowncounter
+ unit: "{collection}"
+ desc: total number of collections that have occurred
+ CollectionTime:
+ metric: elapsed
+ type: updowncounter
+ unit: ms
+ desc: the approximate accumulated collection elapsed time in milliseconds
+
+ - bean: java.lang:type=Memory
+ prefix: jvm.memory.
+ mapping:
+ HeapMemoryUsage.used:
+ metric: heap.used
+ type: updowncounter
+ unit: By
+ desc: current heap usage
+ HeapMemoryUsage.max:
+ metric: heap.max
+ type: gauge
+ unit: By
+ desc: max allowed heap
+ NonHeapMemoryUsage.used:
+ metric: nonHeap
+ type: updowncounter
+ unit: By
+ desc: current non-heap usage
+ NonHeapMemoryUsage.max:
+ metric: nonHeap.max
+ type: gauge
+ unit: By
+ desc: max allowed non-heap
+
+ - bean: java.lang:type=MemoryPool,*
+ prefix: jvm.memory.
+ metricAttribute:
+ name: param(name)
+ mapping:
+ Usage.used:
+ metric: pool.used
+ type: updowncounter
+ unit: By
+ desc: current memory pool usage
+ Usage.max:
+ metric: pool.max
+ type: gauge
+ unit: By
+ desc: max allowed memory pool 
+
+ - bean: java.lang:type=Threading
+ prefix: jvm.threads.
+ mapping:
+ ThreadCount:
+ metric: count
+ type: updowncounter
+ unit: "{thread}"
+ desc: number of threads
+

backend/src/main/resources/logback.xml

@@ -1,35 +1,45 @@
 <?xml version="1.0" encoding="UTF-8"?>
 
-<configuration scan="true">
+<configuration>
+ <contextListener class="ch.qos.logback.classic.jul.LevelChangePropagator">
+ <resetJUL>true</resetJUL>
+ </contextListener>
+
  <if condition='p("LOGBACK_JSON_ENCODE").equals("true")'>
  <then>
  <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
- <encoder class="net.logstash.logback.encoder.LogstashEncoder"/>
+ <encoder class="net.logstash.logback.encoder.LogstashEncoder" />
  </appender>
  </then>
  <else>
  <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
- <encoder>
- <pattern>%d{HH:mm:ss.SSS}%boldYellow(%replace( [%X{cid}] ){' \[\] ', ' '})[%thread] %-5level %logger{5} - %msg%n%rEx</pattern>
- </encoder>
- </appender>
+  <encoder>
+  <pattern><![CDATA[%d{HH:mm:ss.SSS}%boldYellow(%replace( [%X{cid}] ){' \[\] ', ' '})[%thread] %-5level %logger{5} - %msg%n%rEx]]></pattern>
+  </encoder>
+  </appender>
  </else>
  </if>
 
+ <appender name="OpenTelemetry"
+ class="io.opentelemetry.instrumentation.logback.appender.v1_0.OpenTelemetryAppender"></appender>
+
  <logger name="com.softwaremill.bootzooka" level="${LOG_LEVEL:-DEBUG}" additivity="false">
- <appender-ref ref="STDOUT"/>
+ <appender-ref ref="STDOUT" />
+ <appender-ref ref="OpenTelemetry" />
  </logger>
 
- <logger name="sttp.client3" level="${LOG_LEVEL:-DEBUG}" additivity="false">
- <appender-ref ref="STDOUT"/>
+ <logger name="sttp.client3" level="${LOG_LEVEL:-INFO}" additivity="false">
+ <appender-ref ref="STDOUT" />
+ <appender-ref ref="OpenTelemetry" />
  </logger>
 
  <logger name="sttp.tapir" level="${LOG_LEVEL:-DEBUG}" additivity="false">
- <appender-ref ref="STDOUT"/>
+ <appender-ref ref="STDOUT" />
+ <appender-ref ref="OpenTelemetry" />
  </logger>
 
  <root level="${LOG_LEVEL:-INFO}">
- <appender-ref ref="STDOUT"/>
+ <appender-ref ref="STDOUT" />
+ <appender-ref ref="OpenTelemetry" />
  </root>
-
-</configuration>
+</configuration>

backend/src/main/resources/psw4j.properties

@@ -0,0 +1 @@
+global.salt.length=64