apps/wg-easy
1
0
Fork 0
mirror of https://github.com/wg-easy/wg-easy.git synced 2025-10-05 07:37:03 +08:00
Code Issues Packages Projects Releases Wiki Activity
Files
6343213538d11b769f7219bc2aa57a56f9cb0ac6
wg-easy/docs/content/advanced/metrics/prometheus.md
Bernd Storath 1cfe6404b2 Feat docs (#1814) 
* improve docs and formatting

* lint in ci

avoid using bundled prettier from vscode extension

* fix action, typos

* remove header

* remove unused deps
2025-04-15 12:43:57 +02:00

1.4 KiB
Raw Blame History

title
title
Prometheus

To monitor the WireGuard server, you can use Prometheus and Grafana. The container exposes a /metrics/prometheus endpoint that can be scraped by Prometheus.

Enable Prometheus

To enable Prometheus metrics, go to Admin Panel > General and enable Prometheus.

You can optionally set a Bearer Password for the metrics endpoints. This is useful if you want to expose the metrics endpoint to the internet.

Configure Prometheus

You need to add a scrape config to your Prometheus configuration file. Here is an example:

scrape_configs:
    - job_name: 'wg-easy'
      scrape_interval: 30s
      metrics_path: /metrics/prometheus
      static_configs:
          - targets:
                - 'localhost:51821'
      authorization:
          type: Bearer
          credentials: 'SuperSecurePassword'

Grafana Dashboard

You can use the following Grafana dashboard to visualize the metrics:

Grafana Dashboard

21733

/// note | Unofficial

The Grafana dashboard is not official and is not maintained by the wg-easy team. If you have any issues with the dashboard, please contact the author of the dashboard. See #1299 for more information. ///