Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/http-sense/http-sense
When your network-sense tingles 🚨
https://github.com/http-sense/http-sense
cli monitoring-tool network network-analysis network-monitoring
Last synced: about 2 months ago
JSON representation
When your network-sense tingles 🚨
- Host: GitHub
- URL: https://github.com/http-sense/http-sense
- Owner: http-sense
- License: mit
- Created: 2022-12-12T13:29:58.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2023-01-05T08:19:17.000Z (over 1 year ago)
- Last Synced: 2024-06-03T07:33:18.208Z (4 months ago)
- Topics: cli, monitoring-tool, network, network-analysis, network-monitoring
- Language: Rust
- Homepage: https://http-sense.vercel.app
- Size: 788 KB
- Stars: 16
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# HTTP Sense
HTTP Sense is a reverse proxy and network monitoring tool that provides comprehensive network monitoring for your backend servers and microservices. It provides a secure and high-performance gateway that can be used to monitor incoming traffic. HTTP Sense's features include real-time traffic analysis, application-level filtering, user authentication, and more.
**HTTP Sense is built on Supabase and utilizes the following features:**
- Supabase Postgres database - as the primary database
- Supabase Authentication - for RBAC & ABAC
- Supabase Realtime - To listen to realtime DB changes on the HTTP Sense UI
**You can use HTTP Sense for the following:**
- As a network monitoring tool for your production environment (using --publish flag)
- As a reverse proxy for your server in production or even, other lower environments
- As a debugging/monitoring tool during development, like the Browser DevTools are for the browser
- Just for fun
# References
- Video Demo: https://www.youtube.com/watch?v=Qvx4-iaqDq4
- Homepage: https://www.httpsense.com
- Crates: https://crates.io/crates/http-sense
- Git Repository: https://github.com/http-sense/http-sense
# Setting up the repository for development
You will need `cargo` in order to install and run the HTTP Sense CLI. If you do not have cargo installed on your system, please follow the below guide from the official rust-lang docs:
> https://doc.rust-lang.org/cargo/getting-started/installation.html
Once you have `cargo` installed, you can spin up the dev server using the following command:
```bash
cargo run -- --publish
```
Usage Example:
```bash
cargo run -- https://0caf7838-7d0a-4a56-8b04-65a9c6f5815e.mock.pstmn.io --publish
```
- When using the --publish flag, you won't need to run the UI server separately and instead can use the production UI at https://www.httpsense.com
- Once the server has started, it will start intercepting and reverse proxying every request that comes in to your actual server and publishes the monitoring stats to the URL that is provided to you via the CLI. **Please make sure you copy the URL with the hash when opening it in the browser.**
example:
```bash
https://www.httpsense.com/526a0f41-a617-4f9e-8b40-f18d40104f99/#YXN5MW9wdE1VcXVWS0E1MHY3TDdDa0hJT0RyOVZqQGV4YW1wbGUuY29tOjp1Ym56Y0FOeEliM0toajdRazU5bW4xWFgwNVBkNnE=
```
# Installation
If you do not have `cargo` installed, please refer to the above section. Once you have it installed, proceed with the installation for HTTP Sense using the following command:
```bash
# To get the latest and greatest version
cargo install --git https://github.com/http-sense/http-sense
```
After installing HTTP Sense, you can run the CLI server using the commands in the next section.
# CLI Commands & Usage
```bash
Usage: http-sense [OPTIONS]
TLDR:
http-sense http://localhost:8004 --publish
# use port number as short-hand for localhost servers
http-sense 8004 --publish
http-sense httpsense.com --proxy-port 6001 --publish
http-sense http://localhost:8004 --proxy-port 6001 --proxy-addr 0.0.0.0
Options:
--publish
Publish requests to supabase db, allowing you to remotely access request details
-p, --proxy-port
Port at which proxy server should listen
[default: 6100]
-a, --proxy-addr
Address that proxy server should bind to
[default: 127.0.0.1]
--api-port
Port at which api server should listen (Alpha)
[default: 6101]
--api-addr
Address that api server should bind to
[default: 127.0.0.1]
-h, --help
Print help information (use `-h` for a summary)
-V, --version
Print version information
```
# Contributing
If you're looking to contribute to HTTP Sense, please read and follow the guidelines from [CONTRIBUTING.md](https://github.com/http-sense/http-sense/blob/main/CONTRIBUTING.md).
# Contributors
# Maintainers | Code Owners
- [Ankit Saini](https://github.com/nkitsaini)
- [Atchyut Pulavarthi](https://github.com/theonly1me)