Webstat

About

This python module wrapped in a debian package enables users to inspect and export their http traffic.

It provides 2 modes: Sniff and Analyze. The Analyze mode will provide an interactive terminal where the user can choose and export http traffic as metrics over Prometheus, while Sniff mode will inspect entire traffic in real time and expose it as metrics to prometheus. In the first case, users have full control over the data they want to share, in the second, extraction and metrics retrieval is automated.

Features

Sniff mode: Inspects http data, aggregates them and exposes it on port 8000. The exposed metrics will be consumed by prometheus, it is a good idea to run this in background.

Analyze mode: Opens an interactive terminal with a real-time network activity report. User can choose which domain information to be exported as metrics for Prometheus over port 8001.

Dependencies

This project mainly depends on prometheus-client==0.15.0 and is automatically managed by webstat.

Installation

$ sudo add-apt-repository ppa:rnd-smile/webstat
$ sudo apt update
$ sudo apt install python3-webstat

Launch

It is recommended to launch webstat with sudo permissions.

By default, webstat captures packets on the lowest numerical index interface on ifconfig if user doesn't specify a particular interface.

Parameters

-i
Description: Specifies the network interface to capture packets from.
Usage: -i <interface_name>

-m
Description: Sets the mode of operation for Webstat. Choose either 'sniff' to capture packets or 'analyze' to process and analyze captured data.
Usage: -m <sniff/analyze>

--ip
Description: Enables the exposure of ip address information in the captured data.
Usage: --ip

--location
Description: Enables the exposure of location/city information in the captured data.
Usage: --location

# Launch Sniff Mode
$ sudo webstat -m sniff -i eth0 --ip --location
# Sniff mode will enable all metrics on <http://localhost:8000/metrics>

# Launch Analyze Mode 
$ sudo webstat -m analyze
# Analyze mode will enable user selected metrics on <http://localhost:8001/metrics>

These metrics can be added to prometheus as targets.

Prometheus Integration

# Install Prometheus
$ sudo apt install -y prometheus

# Configure prometheus to listen to webstat
$ sudo nano /etc/prometheus/prometheus.yml

Add the following lines under the scrape_configs section:

scrape_configs:
  - job_name: 'sniff-mode'
    static_configs:
      - targets: ['localhost:8000']
  - job_name: 'analyze-mode'
    static_configs:
      - targets: ['localhost:8001']

# Restart prometheus
$ sudo systemctl restart prometheus

Prometheus UI can be accessed here: http://localhost:9090 in any web browser. From there, the real time http activity can be viewed.

Remove Webstat

$ sudo apt purge --auto-remove python3-webstat

License

This project is under license from MIT. For more details, see the LICENSE file.

Credits

Team RnD @ Smile

Smile-SA/webstat