How gongled/kafka-workshop works
Project type and purpose
• This is an educational/training repository that sets up a local Kafka cluster and observability stack via Docker Compose, accompanied by slides, guides, cheatsheets, and code examples (Go producers/consumers).
• Its goal is to let users spin up a Kafka environment, produce and consume messages, and observe metrics in Grafana within 90 minutes.
File structure
• Top-level:
• Dockerfiles (app, kafka) for building images
• docker-compose.yml to orchestrate services
• configs for Prometheus, JMX exporter, Grafana dashboards
• docs/ with theory slides, speaker notes, guides, cheatsheets
• examples/consumer and examples/producer in Go
• Observability:
• jmx-exporter/kafka.yml
• prometheus/prometheus.yml
• grafana/provisioning and dashboards
• No application source code per se, only infrastructure and examples.
README for additional insights
• Two phases: Theory (slides, notes) and Practice (spin up Docker Compose, create topics, run producer/consumer, explore metrics).
• Walk-through guides and cheatsheets point to the key operational steps.
Detail
• Every container and config artifact that affects runtime.
• Ports exposed, e.g., 9092 for Kafka, 9464 for JMX Exporter, 9090 for Prometheus, 3000 for Grafana.
• Environment variables from .env.example that drive broker configuration.