Skip to content

alanconway/korrel8r

 
 

Repository files navigation

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.

Documentation

Contributing

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

License

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

About

Correlation of observability signals.

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Go 91.7%
  • Jsonnet 3.3%
  • Makefile 2.6%
  • Shell 2.1%
  • Dockerfile 0.3%