Skip to main content

Interactive terminal UI for streaming and filtering Kubernetes pod logs across multiple deployments

Project description

kube-orb

Watching logs across a Kubernetes cluster usually means juggling multiple kubectl logs windows and grepping after the fact, or writing complex regex just to add a couple of filters. kube-orb streams kubectl logs -f from every pod in your selected deployments into one merged, colorized view — and lets you filter, highlight, and search while it's streaming.

Built with Textual, kube-orb is a full terminal UI: an interactive setup wizard walks you through picking a namespace, deployments, and filter patterns — no flags required — or skip straight to the viewer with CLI arguments if you prefer. Save named session configs to reload your exact setup later; passively collect rare events in a monitor panel without losing your scroll position; get alerted when pods restart or go unhealthy; and add or remove deployments from the live stream without restarting.

kube-orb viewer

Features

  • Multi-pod live tail — stream logs from any number of pods/deployments at once, each with a distinct color.
  • Filters — hide lines matching a pattern, live-editable mid-session.
  • Highlights — emphasize lines matching a pattern without hiding anything else.
  • Monitors — passively collect matching lines into a separate panel so you can watch for rare events (e.g. job failed) without losing your scroll position in the main stream.
  • Live search — search the whole buffered session, jump to a result, and keep streaming.
  • Pod health panel — flags pods that aren't Running or have crossed a restart threshold; restart a pod or roll out a deployment restart from inside the app.
  • Dump mode — fetch existing logs once (with --tail/--since) and exit, for scripting or one-off inspection, instead of a live stream.
  • Saved configs — save a named combination of namespace, deployments, and patterns, and reload it later by name.
  • JSON log formatting — auto-detects structured JSON log lines and shows time LEVEL message key=value ... instead of a raw JSON blob, with a toggle back to raw and a detail view (Enter on a clicked line) for the full pretty-printed object.
  • Collapse repeated lines — journalctl-style: consecutive identical lines from the same pod fold into a single "last line repeated N times" marker, toggleable, so a crash-looping pod doesn't flood the stream.

Installation

Requires Python 3.10+ and kubectl on your PATH, configured against the cluster you want to inspect (kube-orb shells out to your existing kubectl and inherits its context/auth — no separate credentials or Kubernetes client library involved).

git clone https://github.com/adlidev/kube-orb.git
cd kube-orb
pip install -e .
# or, with uv:
uv pip install -e .

This installs two commands: kube-orb and kube-orb-inject (a small test utility — see the User Guide).

Quick start

# No arguments — launches the interactive setup wizard
kube-orb

# Skip the wizard: watch two deployments live
kube-orb -n production -p api-gateway -p auth-service

# Watch every deployment in a namespace
kube-orb -n staging --all-pods

# One-shot dump instead of a live stream
kube-orb -n staging --dump --tail 500

# Pre-filter/highlight from the command line
kube-orb -n default -p worker -f DEBUG -H ERROR --health

Once you're in the viewer, press F / H / M to edit filters, highlights, or monitors live, / to search, P to add/remove streamed deployments, and Space to pause. See the User Guide for the full keybinding reference and pattern syntax.

Development

pip install -e . --group dev
pytest                    # run the test suite
textual run --dev src/kube_orb/__main__.py   # live-reload dev mode

A local, disposable k3d cluster with fake log-generating services is included for manual testing — see CLAUDE.md for setup and architecture notes.

License

MIT License

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

kube_orb-1.0.0.tar.gz (332.4 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

kube_orb-1.0.0-py3-none-any.whl (61.1 kB view details)

Uploaded Python 3

File details

Details for the file kube_orb-1.0.0.tar.gz.

File metadata

  • Download URL: kube_orb-1.0.0.tar.gz
  • Upload date:
  • Size: 332.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.9.6

File hashes

Hashes for kube_orb-1.0.0.tar.gz
Algorithm Hash digest
SHA256 89b27a2743538a4ce384a91c2408367e47262545602500dd32f5a7f144b8af13
MD5 8a0e3f89c0b4a6b2ce0ef37f865d95ba
BLAKE2b-256 8ae2c27da6af1dd7ef1484bf57e6c2f5b22307d6bd94f7ebff07d43074211649

See more details on using hashes here.

File details

Details for the file kube_orb-1.0.0-py3-none-any.whl.

File metadata

  • Download URL: kube_orb-1.0.0-py3-none-any.whl
  • Upload date:
  • Size: 61.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.9.6

File hashes

Hashes for kube_orb-1.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 e1380472c58358c5e6097b9cc4d80fa099557047b46441539f8619bc2b8fcfdb
MD5 cadca2d2145448033e73b576d194b09b
BLAKE2b-256 ab838c72898349ea833b1b0bdb2664e3bf76c0733c7ed57ebae5080c28fae50e

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page