An open API service indexing awesome lists of open source software.

https://github.com/korrel8r/korrel8r

Correlation of observability signals.
https://github.com/korrel8r/korrel8r

4bb alerts correlation kubernetes logging metrics observability

Last synced: 3 months ago
JSON representation

Correlation of observability signals.

Awesome Lists containing this project

README

          

# Korrel8r

[![Go Reference](https://pkg.go.dev/badge/github.com/korrel8r/korrel8r.svg)](https://pkg.go.dev/github.com/korrel8r/korrel8r)
[![Build](https://github.com/korrel8r/korrel8r/actions/workflows/build.yml/badge.svg)](https://github.com/korrel8r/korrel8r/actions/workflows/build.yml)
[![Publish](https://github.com/korrel8r/korrel8r/actions/workflows/publish.yml/badge.svg)](https://github.com/korrel8r/korrel8r/actions/workflows/publish.yml)

Korrel8r is an observability tool for correlating observable signals and resources in a kubernetes cluster.

It is a _rule based correlation engine_, with an extensible rule set, that can navigate
- many types of signal and resource data
- serialized in diverse formats, with diverse schema, data models and naming conventions
- queried using diverse query languages
- stored in multiple stores with diverse query APIs

The [Korrel8r Documentation Site](https://korrel8r.github.io/korrel8r) explains the ideas behind korrel8r,
how to use the built-in rules, and how to write new rules.

These Go packages include:
- [Core abstractions and interfaces](https://pkg.go.dev/github.com/korrel8r/korrel8r/pkg/korrel8r)
need to implement new [domains](https://korrel8r.github.io/korrel8r#id-about-domains)

- [Domain packages](https://pkg.go.dev/github.com/korrel8r/korrel8r/pkg/domains) for k8s resources, alerts, logs, metris and more

If you are interesting in contributing or experimenting see the [Hackers guide](./doc/HACKING.adoc)

⚠️ **NOTE**: _Early development, no compatibility guarantees_ ⚠️