wg_exporter

wg_exporter is a Python-based tool designed to collect and expose WireGuard VPN metrics. It runs as a service on your system and provides metrics in a format that can be scraped by Prometheus.

Features

Collects WireGuard interface and peer metrics.
Exposes metrics via an HTTP endpoint.
Configurable logging for development and production environments.

Prerequisites

Python 3.6+
WireGuard installed and configured
Prometheus (for scraping the metrics)
Git

Installation

Clone the Repository

git clone git@github.com:Wisienkas/wg_exporter.git
cd repository

Set Up a Virtual Environment (Optional but Recommended)

python3 -m venv venv
source venv/bin/activate  # On Windows use `venv\Scripts\activate`

Install Dependencies
```
pip install -r requirements.txt
```

Configuration

Environment Variables
- ENV: Determines the environment configuration to use (default is development).
- WG_EXPORTER_LOG_FILE: Path to the log file. This can be set in the environment variables or in the config.ini file.
Configuration File

Create a config.ini file in the same directory as your configuration module (config.py). This file should define the log file paths for different environments. (This is included with the build as below)
```
[development]
WG_EXPORTER_LOG_FILE = ./wg_exporter_dev.log

[production]
WG_EXPORTER_LOG_FILE = /var/log/wgexporter/wg_exporter.log
```

Setting Up the Service User

To enhance security, it is recommended to run the wg_exporter service as a dedicated, non-privileged user. Follow these steps to create the user and set up the service.

Create the wgexporter User

sudo useradd --system --no-create-home --shell /usr/sbin/nologin wgexporter

Setting Up the Directory Structure

Create the Directory Structure

Create the preferred directory structure under /etc/local/bin/wg_exporter/:

sudo mkdir -p /etc/local/bin/wg_exporter
cd wg_exporter
sudo cp -r * /etc/local/bin/wg_exporter/
cd ..
sudo chown -R wgexporter:wgexporter /etc/local/bin/wg_exporter

**install.sh file can also be run to achieve this, as ./install.sh

Running the Exporter

Development

To run the exporter in development mode:

python /etc/local/bin/wg_exporter/__init__.py

Production

Set Up Logging Directory

sudo mkdir /var/log/wgexporter
sudo chown wgexporter:wgexporter /var/log/wgexporter

Systemd Service Configuration

Create a systemd service file /etc/systemd/system/wg_exporter.service:

[Unit]
Description=WireGuard Exporter
After=network.target

[Service]
User=wgexporter
Group=wgexporter
Environment=ENV=production
ExecStart=/usr/bin/env python3 /etc/local/bin/wg_exporter/server.py
Restart=always

[Install]
WantedBy=multi-user.target

Enable and Start the Service

sudo systemctl daemon-reload
sudo systemctl enable wg_exporter
sudo systemctl start wg_exporter

Accessing Metrics

The metrics are exposed via an HTTP endpoint on port 9586. You can access them by navigating to:

http://localhost:9586/metrics

Prometheus Configuration

Add the following job to your Prometheus configuration file (prometheus.yml):

scrape_configs:
  - job_name: 'wireguard'
    static_configs:
      - targets: ['localhost:9586']

Contributing

Feel free to open issues or submit pull requests if you have any improvements or bug fixes.

License

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

Wisienkas/wg_exporter