Skip to content
Klag Klag

Quick Start

The fastest way to try Klag is the published Docker image.

Docker (JVM)

Section titled “Docker (JVM)”
Terminal window
docker run -e KAFKA_BOOTSTRAP_SERVERS=kafka:9092 \
           -e METRICS_REPORTER=prometheus \
           -p 8888:8888 \
           themoah/klag:latest

Metrics are then available at http://localhost:8888/metrics.

Native image (faster startup, lower memory)

Section titled “Native image (faster startup, lower memory)”

A GraalVM native build is published alongside the JVM image, tagged :native and :<version>-native:

Terminal window
docker run -e KAFKA_BOOTSTRAP_SERVERS=kafka:9092 \
           -e METRICS_REPORTER=prometheus \
           -p 8888:8888 \
           themoah/klag:native

The native binary starts in ~70–100 ms using ~44 MB RSS, versus ~500 ms / ~119 MB for the JVM image, ideal for fast scaling and low-footprint deployments. Same config, endpoints, and metrics. See Native Image for build details.

HTTP endpoints

Section titled “HTTP endpoints”

Once running, Klag exposes:

EndpointPurpose
/healthzLiveness probe (always 200).
/readyzReadiness probe (200 if Kafka UP, 503 if DOWN).
/metricsPrometheus scrape endpoint (when enabled).
/versionBuild information.
/mcpMCP endpoint for AI agents (when MCP_ENABLED=true).

What’s next

Section titled “What’s next”