Skip to content
KlagKlag

Installation

Klag ships as a Docker image and a Helm chart. The bare application defaults METRICS_REPORTER to none, so Docker and binary deployments must select prometheus, datadog, or otlp. The Helm chart defaults metrics.reporter to prometheus.

Helm chart

Section titled “Helm chart”

The chart is published to a Helm repository served from GitHub Pages and indexed on Artifact Hub.

Terminal window
helm repo add klag https://themoah.github.io/klag
helm repo update
helm search repo klag   # find the latest version


helm install klag klag/klag \
  --set kafka.bootstrapServers="kafka-broker:9092"

For repeatable deployments, choose a version from helm search repo klag --versions and pass it with helm install --version <chart-version>.

Terminal window
helm install klag klag/klag \
  --set kafka.bootstrapServers="kafka:9092" \
  --set kafka.securityProtocol="SASL_SSL" \
  --set kafka.saslMechanism="PLAIN" \
  --set kafka.saslJaasConfig="org.apache.kafka.common.security.plain.PlainLoginModule required username='user' password='pass';"

See the chart README for full configuration options, and Kubernetes deployment for production guidance.

Docker with an environment file

Section titled “Docker with an environment file”
Terminal window
docker run --env-file .env themoah/klag:latest

A sample .env:

# Kafka connection
KAFKA_BOOTSTRAP_SERVERS=instance.gcp.confluent.cloud:9092
KAFKA_SECURITY_PROTOCOL=SASL_SSL
KAFKA_SASL_MECHANISM=PLAIN
KAFKA_SASL_JAAS_CONFIG="org.apache.kafka.common.security.plain.PlainLoginModule required username=${SASL_USERNAME} password=${SASL_PASSWORD};"


# Metrics
METRICS_REPORTER=prometheus
METRICS_INTERVAL_MS=30000
METRICS_GROUP_FILTER=*
METRICS_GROUP_EXCLUDE=


# Optional: JVM metrics
METRICS_JVM_ENABLED=true

Next steps

Section titled “Next steps”