All modules
Every Bootable module, by function.
Every module Bootable publishes, by function.
Within a function, each group’s heading says how to pick from it: choose one, or optional, both of which are dependencies you add, or comes with another module, which you don’t add yourself.
A module marked (-otel) has an -otel variant: the same module, with its telemetry added, which you use in its place.
A module with -kodein, -metro, or -inara flavours is installed in the flavour of your wiring style; see Choosing a wiring style.
Core
| Module | What it provides |
|---|---|
|
|
|
Small helpers the other modules share |
Configuration
See Configuration.
| Module | What it provides |
|---|---|
Config library: choose one |
|
|
|
Common: comes with the config library, and the modules that read config |
|
|
|
Environment
See Environment.
| Module | What it provides |
|---|---|
|
Logging
See Logging (Log4j2).
| Module | What it provides |
|---|---|
Log4j2: comes with |
|
Log4j2, with layouts for plain, coloured, JSON, and Google Cloud output |
|
Core: comes with Log4j2 |
|
|
|
Database
See Database.
| Module | What it provides |
|---|---|
Driver: choose one |
|
|
|
|
|
|
|
Connection pool: choose one |
|
|
|
Migrations: optional |
|
|
|
ORM: optional |
|
|
|
Statement tracing: optional |
|
A span for each statement, with |
|
Core: comes with the driver |
|
|
|
Web / HTTP
See Web / HTTP.
| Module | What it provides |
|---|---|
Server engine: choose one, for a server |
|
Ktor’s CIO engine |
|
Ktor’s Netty engine |
|
Server telemetry: optional |
|
Each request traced and measured, and a metrics scrape |
|
Server: comes with the engine; with Kodein or Metro, add it too, for its flavour |
|
|
|
Client engine: choose one, for a client |
|
Ktor’s CIO engine |
|
The JDK’s |
|
Client telemetry: optional |
|
Each call traced and measured |
|
Client: comes with the engine; with Kodein or Metro, add it too, for its flavour |
|
|
|
Background work
See Background work.
| Module | What it provides |
|---|---|
Periodic work: optional |
|
|
|
Leader election: optional |
|
|
|
Scheduled tasks: optional |
|
|
|
Leader election API: comes with |
|
|
|
Telemetry
| Module | What it provides |
|---|---|
SDK: add it, for export over OTLP, or an exporter or integration, which brings it in |
|
|
|
Exporters and integrations: optional |
|
The metrics, for Prometheus to scrape |
|
Traces and metrics to SigNoz, over OTLP |
|
Google Cloud’s resource attributes, and export to Cloud Trace and Cloud Monitoring over OTLP |
|
A Micrometer |
|
API: comes with the SDK, and with the modules that trace |
|
|
|
Testing
See Testing.
| Module | What it provides |
|---|---|
Test helpers: optional, as test dependencies |
|
Helpers for unit tests, such as a test clock, captured logs, and the start plan, without booting the application |
|
An in-memory OpenTelemetry SDK, to check a component’s spans and metrics |
|