Skip to main content

Terminal UI to monitor Kontiki services, registry events, and logs.

Project description

KontikiTUI

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, pid/host, version, local stats when possible),
  • inspect events and exceptions recorded by the registry,
  • read logs without leaving the terminal.

Tabs

  • Services: registered services with status, pid/host, version and local stats (CPU/MEM/FD when possible, otherwise N/A). Selecting a row shows the configuration/metadata in JSON.

    Services tab

  • Events: events tracked by the registry, with local filters (Field/Value/Limit). RPC-like events are displayed as rpc:<remote_method> when event_type is empty.

    Events tab

  • Exceptions: exceptions from the registry exception tracker, with the same local filtering approach. The context payload is shown compactly.

    Exceptions tab

  • 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.

    Logs tab

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

    Settings tab


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.

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

kontiki_tui-0.1.0.tar.gz (20.5 kB view details)

Uploaded Source

Built Distribution

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

kontiki_tui-0.1.0-py3-none-any.whl (30.7 kB view details)

Uploaded Python 3

File details

Details for the file kontiki_tui-0.1.0.tar.gz.

File metadata

  • Download URL: kontiki_tui-0.1.0.tar.gz
  • Upload date:
  • Size: 20.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.3.2 CPython/3.11.9 Linux/6.17.9-76061709-generic

File hashes

Hashes for kontiki_tui-0.1.0.tar.gz
Algorithm Hash digest
SHA256 dcdc09ae705c9a95c13c2085ef2a865149d73e72d54d8d64dd8c10acac0be7bf
MD5 7f04a8111507037362596f609461cf7a
BLAKE2b-256 b16b8d5825dcdcae98c29bd699cf3c7e4cb0e5b6c111f2f2e7e2d399464ae44f

See more details on using hashes here.

File details

Details for the file kontiki_tui-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: kontiki_tui-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 30.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.3.2 CPython/3.11.9 Linux/6.17.9-76061709-generic

File hashes

Hashes for kontiki_tui-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 457f869839743d6315fc3885c0d85f1d8c2419bb5c9dacc1a4d64bc505b8acb3
MD5 1dde5991253b4e10a51ba3227f021e3c
BLAKE2b-256 a33fa0846cce2163da8b6de25b604f814d6c2e25795727623fd2e7d9163ce417

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