Antop

A terminal dashboard for monitoring Autonomi node instances.

Features

• Automatic Discovery: Finds running antnode instances by scanning log files (configurable path).
• Real-time Metrics: Fetches and displays key metrics from discovered nodes.
• TUI Dashboard: Presents information clearly in your terminal using ratatui.

Installation

Prerequisites

• Rust (stable toolchain)

From Crates.io (recommended)

cargo install antop

From Source

1. Clone the repository:

   git clone https://github.com/champii/antop.git
   cd antop
   

2. Build the release binary:

   cargo build --release
   

3. The executable will be located at target/release/antop.

Usage

1. Run the application:

   antop
   

   Or, if installed via source:

   cargo run
   

2. Node Discovery:

   • By default, antop looks for node root directories in ~/.local/share/autonomi/node/* to find information like storage paths. Use --path to override this.
   • It also scans for log files using the pattern ~/.local/share/autonomi/node/*/logs/antnode.log to discover metrics server addresses.
   • You can override the node directory discovery path using the --path option:

   antop --path "/path/to/your/nodes/node-*"
   

   • You can override the log file discovery path using the --log-path option with a glob pattern matching the specific log files:

   antop --log-path "/custom/log/location/node-*/antnode.log"
   

License

This project is licensed under the MIT License. See the LICENSE file for details.