cluster-health-analyzer

command module
v1.2.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Nov 2, 2026 License: Apache-2.0 Imports: 1 Imported by: 0

README

Cluster Health Analyzer

An analyzer for OpenShift cluster health data.

Overview

The Cluster Health Analyzer processes the incoming stream of health signals from the OpenShift cluster and enriches them to provide better views of the data to enhance the troubleshooting experience.

It provides:

  • Incidents detection: heuristics to group individual alerts together to allow better reasoning about the root cause of the issues.
  • Components mapping and ranking: an opinionated way to assign the alerts to high-level components and rank them based on the importance of the components from the overall cluster health perspective.

Install

Login to a cluster using oc login command:

oc apply -f manifests/backend

Usage

The Cluster Health Analyzer is a backend that exposes results as Prometheus metrics:

  • cluster_health_components_map — maps source signals (alerts) to components and incident groups
  • cluster_health_components — metadata and ranking of components in the system
  • cluster:health:group_severity:count — current counts of group IDs by severity
  • component_health_alert — health status of a component based on alerts
  • component_health_object — health status of a component based on Kubernetes objects
  • component_health — health status of a component based on the child objects

See the metrics at /metrics on the running service.

Contributing

See CONTRIBUTING.md for development setup, testing, and contribution guidelines.

Evaluations

To run MCP tool evaluations locally with mcpchecker:

make install-mcpchecker
make run-evals

See evals/mcpchecker/README.md for full instructions.

Documentation

See docs/ for detailed architecture and subsystem documentation.

Documentation

The Go Gopher

There is no documentation for this package.

Directories

Path Synopsis
cmd
mcp
pkg
mcp
processor
Package processor contains the core logic for processing alerts and updating the health map metrics.
Package processor contains the core logic for processing alerts and updating the health map metrics.
server
Package server contains the core logic for starting processor and serving resulting metrics.
Package server contains the core logic for starting processor and serving resulting metrics.
test/mocks
Package mocks is a generated GoMock package.
Package mocks is a generated GoMock package.
test
integration/framework
Package framework provides utilities for integration testing.
Package framework provides utilities for integration testing.
integration/simulate
Package simulate provides utilities for running stress tests via the simulate command.
Package simulate provides utilities for running stress tests via the simulate command.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL