Navigate relationships between cluster resources and observability signals
Kubernetes clusters generate observability data across diverse systems - logs, metrics, traces, alerts, and events - each with different data models, query languages, and APIs. Troubleshooting requires manually piecing together information from multiple sources, which is time-consuming and error-prone.
Korrel8r is a rule-based correlation engine that automatically discovers and graphs relationships between cluster resources and observability signals across multiple data stores, enabling unified troubleshooting experiences.
- Universal correlation across multiple formats, stores, and query languages
- Multi-store relationships spanning Prometheus, Loki, Alertmanager, Kubernetes API, and more
- Extensible rules defined in configurable YAML files
- Extensible domains for new signal types, query languages, and data stores
- Flexible deployment as a REST service or command-line tool
- Cluster operators troubleshooting issues across complex Kubernetes environments
- Tool builders creating observability and troubleshooting interfaces
- Integrated solutions like the OpenShift troubleshooting panel
Get Started: See the User Guide for installation, usage, and configuration details.
- User Guide - Complete installation, usage, and reference guide
- Developer Guide - Contributing and development setup
- GitHub Issues - Report bugs or request features
- GitHub Discussions - Community support
We welcome contributions! See the Developer Guide for setup instructions, development workflows, and contribution guidelines.
- Project Board - Current work and project status
- Pull Requests - Submit contributions
Korrel8r includes custom commands for Claude Code to streamline development:
/generate-rule- Interactive assistant for creating correlation rules- See .claude/commands/ for all available commands
The Developer Guide includes specific tips for AI agents working with the codebase.
# Latest release
go install github.com/korrel8r/korrel8r/cmd/korrel8r@latest # Executable
docker pull quay.io/korrel8r/korrel8r:latest # Image
# Daily images from main for development, not tested for release.
docker pull quay.io/korrel8r/korrel8r:dev-latest # Latest
docker pull quay.io/korrel8r/korrel8r:dev-v0.8.4-9-g7304c37 # 9 commits since release 0.8.4 See all available images at: https://quay.io/repository/korrel8r/korrel8r?tab=tags
This project is licensed under the Apache License 2.0 - see the LICENSE file for details.