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

boot

Bootable: the application’s services and lifecycle controllers, run phase by phase, and Health

boot-common

Small helpers the other modules share

Configuration

Module What it provides

Config library: choose one

boot-config-hoplite

ConfigBinder over Hoplite, from HOCON and the environment

Common: comes with the config library, and the modules that read config

boot-config-common

ConfigBinder, and Masked, for secrets in config

Environment

Module What it provides

boot-env

environment: the deployment environment, such as dev or prod, from config

Logging

Module What it provides

Log4j2: comes with boot; add it yourself to call its API, such as LoggingType

boot-logging-log4j2

Log4j2, with layouts for plain, coloured, JSON, and Google Cloud output

Core: comes with Log4j2

boot-logging

BootLoggingLevel

Database

See Database.

Module What it provides

Driver: choose one

boot-db-jdbc-sqlite

SqliteConfig, and the SQLite driver

boot-db-jdbc-postgresql

PostgresqlConfig, the PostgreSQL driver, and Flyway’s PostgreSQL support

boot-db-jdbc-mysql

MysqlConfig, Connector/J, and Flyway’s MySQL support

Connection pool: choose one

boot-db-pool-hikari (-otel)

HikariConnectionPoolFactory: HikariCP, configured by HikariPoolConfig
Or boot-db-pool-hikari-otel, with telemetry: the pool’s metrics, with hikariPoolMetrics

Migrations: optional

boot-db-flyway

FlywayMigrationService: Flyway’s migrations, when the application starts

ORM: optional

boot-db-exposed

ExposedDatabaseService, an Exposed Database over the pool, and SchemaVerificationService

Statement tracing: optional

boot-db-jdbc-otel

A span for each statement, with jdbcTracing

Core: comes with the driver

boot-db-jdbc

JdbcDataSourceService: the pool, tied to the application’s lifecycle, and its health check

Web / HTTP

See Web / HTTP.

Module What it provides

Server engine: choose one, for a server

boot-server-http-ktor-cio

Ktor’s CIO engine

boot-server-http-ktor-netty

Ktor’s Netty engine

Server telemetry: optional

boot-server-http-ktor-otel

Each request traced and measured, and a metrics scrape

Server: comes with the engine; with Kodein or Metro, add it too, for its flavour

boot-server-http-ktor

KtorService: a Ktor server that starts and stops with the application, and KtorHealth, which serves the liveness and readiness probes

Client engine: choose one, for a client

boot-client-http-ktor-cio

Ktor’s CIO engine

boot-client-http-ktor-java

The JDK’s HttpClient, as Ktor’s Java engine

Client telemetry: optional

boot-client-http-ktor-otel

Each call traced and measured

Client: comes with the engine; with Kodein or Metro, add it too, for its flavour

boot-client-http-ktor

KtorClientService: the application’s Ktor HttpClients, closed when it stops

Background work

Module What it provides

Periodic work: optional

boot-periodic

PeriodicAppService: a loop in the background, on the leader only if you like
With telemetry: a trace for each run

Leader election: optional

boot-leader-k8s

KubernetesLeaderElection: a leader among the pods, with a Lease

Scheduled tasks: optional

boot-scheduler-db

DbSchedulerService: db-scheduler’s persistent tasks, over the application’s database
With telemetry: a trace for each execution

Leader election API: comes with boot-periodic and boot-leader-k8s

boot-leader-common

LeaderElection, and AlwaysLeader, the leader of an application that runs as one instance

Telemetry

Module What it provides

SDK: add it, for export over OTLP, or an exporter or integration, which brings it in

boot-telemetry-otel

OpenTelemetryService: the application’s OpenTelemetry SDK, for traces and metrics, pushed over OTLP

Exporters and integrations: optional

boot-telemetry-otel-prometheus

The metrics, for Prometheus to scrape

boot-telemetry-otel-signoz

Traces and metrics to SigNoz, over OTLP

boot-telemetry-otel-gcp

Google Cloud’s resource attributes, and export to Cloud Trace and Cloud Monitoring over OTLP

boot-telemetry-otel-micrometer-bridge

A Micrometer MeterRegistry, for libraries that report only to Micrometer

API: comes with the SDK, and with the modules that trace

boot-telemetry-otel-common

withSpan, withRootSpan, and Sample, over the OpenTelemetry API alone, for code that traces without depending on the SDK

Testing

See Testing.

Module What it provides

Test helpers: optional, as test dependencies

boot-test

Helpers for unit tests, such as a test clock, captured logs, and the start plan, without booting the application

boot-test-otel

An in-memory OpenTelemetry SDK, to check a component’s spans and metrics