Home
Softono

Korrel8r

Open source Apache-2.0 Go
159
Stars
17
Forks
18
Issues
4
Watchers
3 months
Last Commit

 About Korrel8r

Correlation of observability signals.

Platforms

Web Self-hosted Kubernetes

Languages

Go

Need Help Installing Korrel8r?

We provide expert installation service for this software. Our team will install, configure, and secure Korrel8r on your server. plans start at just $30.

Korrel8r

Go Reference Build Publish Daily Image

Navigate relationships between cluster resources and observability signals

What is Korrel8r?

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.

Key Features

  • 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

Use Cases

  • 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.

Installing

# 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

Documentation

Contributing

We welcome contributions! See the Developer Guide for setup instructions, development workflows, and contribution guidelines.

AI-Assisted Development

Korrel8r includes custom commands for Claude Code to streamline development:

  • /generate-rule - Interactive assistant for creating correlation rules.
  • See .claude/commands/ for available commands.

License

This project is licensed under the Apache License 2.0 - see the LICENSE file for details.