KontikiTUI

Part of the Kontiki suite — a compact open-source stack for startups and small teams that need ops without the heavy stack.

Full suite overview → https://kontiki-org.github.io/

Ops demo → kontiki-monitor Quickstart.

Overview

KontikiTUI is a small terminal UI for monitoring Kontiki systems via the Kontiki service registry and log files.

It is built with Textual, a Python TUI framework.

It is “engineering‑tool” oriented:

• quick view of running services (status, last heartbeat, degraded reason, host/pid, version),
• inspect events and exceptions recorded by the registry,
• read logs without leaving the terminal.

Tabs

• Services: registered services with status, last heartbeat, degraded reason, host/pid, and version (Kontiki ≥1.9.0). Selecting a row shows the configuration/metadata in JSON.

  Defaults to the business registration group via the session Group Select on each monitoring tab (all / business / platform / …). Changing it in one tab updates all tabs. Missing/blank Registry group counts as business. Instance column shows the Kontiki short id (12 hex), not the full UUID.

  

• Events: events tracked by the registry, with local filters (Field/Value/Limit). Domain publishes and RPC calls are shown (rpc:<remote_method> when there is no event_type). Hides registry bookkeeping and TUI observer traffic. Filtered by the same session Group Select (registry jointure). Deregistered instances fall back to business.

  

• Exceptions: exceptions from the registry exception tracker, with the same local filtering approach. Also filtered by the session Group Select. The context payload is shown compactly.

  

• Logs: reads configured log files from logs.directory and displays them in the UI. Uses lnav when available; otherwise it falls back to a Python reader. When services use Kontiki ≥1.8.1 (logging.directory in their config), log files are named {service_name}-{short_instance_id}.log and filtered by the session Group Select. ServiceRegistry-*.log is never included (observer / registry process noise). Files that do not follow Kontiki naming are always shown.

  

• Settings: edit ~/.config/kontiki_tui.yaml (the app reloads configuration on save).

  

Requirements

• Optional: lnav for richer log filtering; without it, a built-in Python reader is used

Quickstart

Install from PyPI

pip install kontiki-tui
kontiki-tui

(package on PyPI)

Install from source (Poetry)

make install
make run

Test stack (RabbitMQ + registry + example services)

In one terminal:

make stack-up

In another terminal:

make run

Launch examples to view events and exceptions

make run-rpc-example
make run-simple-event-example

To stop:

make stack-down

Contributing

See CONTRIBUTING.md.

License

Licensed under the Apache License, Version 2.0. See LICENSE and NOTICE.