Skip to content

stackrox/sensor-metrics-analyzer

Repository files navigation

StackRox Sensor Metrics Analyzer

A standalone Go binary that analyzes StackRox Sensor Prometheus metrics using declarative TOML rule files.

Made with VHS

🎬 Demos

Interactive TUI Mode

TUI Demo

CLI Mode (Console & Markdown)

CLI Demo

✨ Features

  • 🎮 Interactive TUI: Beautiful terminal UI with keyboard navigation (powered by Bubble Tea)
  • 📊 Load-Aware Analysis: Automatically detects cluster load level (low/medium/high) and adjusts thresholds accordingly
  • 🔗 Correlation Rules: Rules can reference other metrics for intelligent status evaluation
  • 🏷️ ACS Versioning: Rules specify supported ACS versions and are filtered automatically
  • 📝 Template-Based Reports: Markdown reports generated from templates
  • 🖥️ Console Output: Default colorful console output with tables

Installation

make build

Usage

⚠️ Note: Flags must come BEFORE the metrics file!

Interactive TUI Mode (Recommended)

# Launch interactive terminal UI
./bin/metrics-analyzer analyze --format tui --rules ./automated-rules metrics.txt

TUI Features:

  • Navigate results with / or j/k keys
  • Press Enter to view detailed information
  • Filter by status with 1-4 keys (All/Red/Yellow/Green)
  • Search with / key
  • Press ? for help

Console & Markdown Output

# Analyze metrics (console output - default)
./bin/metrics-analyzer analyze metrics.txt

# Analyze with custom rules directory
./bin/metrics-analyzer analyze --rules ./automated-rules metrics.txt

# Generate markdown report
./bin/metrics-analyzer analyze --format markdown --output report.md metrics.txt

# Override load level
./bin/metrics-analyzer analyze --load-level high metrics.txt

# Specify ACS version
./bin/metrics-analyzer analyze --acs-version 4.8 metrics.txt

Utility Commands

# Validate rules (defaults to current directory)
./bin/metrics-analyzer validate

# Validate rules in specific directory
./bin/metrics-analyzer validate ./automated-rules

# List all rules
./bin/metrics-analyzer list-rules

More Documentation

Dependencies

Built with:

Additional Docs

License

Apache 2.0 - See LICENSE for details.

About

Analyze metrics from Stackrox Sensor and discover potential problems. (Code is still mostly AI-generated)

Resources

License

Stars

Watchers

Forks

Contributors