Lib.rs

🦀 Overview

Welcome to the tokio-console-web project! This project is a web-based console for the console-subscriber crate. It is designed to be a simple, easy-to-use, and powerful tool for monitoring and debugging your tokio applications.

🚀 Getting Started

To use tokio-console-web, follow these steps:

1. Enable the grpc_web feature in your console-subscriber dependency:

   [dependencies]
   console-subscriber = { version = "0.4.0", features = ["grpc-web"] }
   

2. Configure your application to use the ConsoleLayer with gRPC-Web enabled:

   use std::net::Ipv4Addr;
   
   console_subscriber::ConsoleLayer::builder()
       .enable_grpc_web(true)
       .server_addr((Ipv4Addr::UNSPECIFIED, 9999))
       .init();
   

3. Install tokio-console-web using Cargo:

   cargo install tokio-console-web
   

   Additional installation methods can be found on the release page.

4. Start the tokio-console-web server:

   tokio-console-web
   

   Access the web console at http://127.0.0.1:3333 in your browser.

For more options:

$ tokio-console-web --help
A web console for tokio

Usage: tokio-console-web[EXE] [OPTIONS]

Options:
      --host <HOST>  The address to listen on [default: 127.0.0.1]
      --port <PORT>  The port to listen on [default: 3333]
  -h, --help         Print help
  -V, --version      Print version

🛠️ Contributing

Contributions are welcome! Please feel free to submit a Pull Request. If you have any questions, please feel free to ask in the Discord server.

⚖️ License

Licensed under either of these:

• Apache License, Version 2.0, (LICENSE-APACHE or https://www.apache.org/licenses/LICENSE-2.0)
• MIT license (LICENSE-MIT or https://opensource.org/licenses/MIT)