Prometheus WireGuard Exporter

Prometheus WireGuard Exporter is an Unraid plugin that collects metrics from your WireGuard VPN and exposes them on a Prometheus-compatible /metrics endpoint…

  • Monitoring & Logging
  • Network Services
  • Plugins
  • Productivity
  • Tools & Utilities
Prometheus WireGuard Exporter is an Unraid plugin that collects metrics from your WireGuard VPN and exposes them on a Prometheus-compatible /metrics endpoint (port 9586). It reports VPN and tunnel statistics so you can graph and alert on your WireGuard server in Prometheus or any other tool that reads Prometheus metrics. It wraps MindFlavor's open-source exporter and is aimed at homelab operators who want to monitor VPN health and traffic without running a separate exporter container.

Platform availability

Available on 1 of 10 platforms

  • Unraid
  • TrueNAS (not listed)
  • Umbrel (not listed)
  • ZimaOS (not listed)
  • Proxmox (not listed)
  • Helm (not listed)
  • Mac (not listed)
  • Windows (not listed)
  • Linux (not listed)
  • Any server (not listed)

Health score?A 0-100 score computed nightly from four factors: maintained (40%: recent commits and steady activity), popular (25%: GitHub stars, log scale), easy to install (20%: platforms, install notes, setup guides, Docker image) and light to run (15%: minimum RAM, ARM support). When the source code has been checked, a fifth factor, security check (20%: automated scan for committed secrets, unsafe desktop-app settings, known-vulnerable dependencies and project hygiene; any serious finding caps it at 20), is added. Factors without data are left out and the rest are rescaled.

30/100 Low

Maintained
0last commit 1461 days ago
Popular
56607 GitHub stars
Easy to install
251 install platform, install notes
Light to run
No data
Security check
60no serious findings, 2 minor, CI, OpenSSF Scorecard 3.2/10

Based on 4 of 5 factors.

Availability: platform listings confirmed today, links checked 4 days ago

GitHub stars
607
Open issues
37
Last commit
2022-11-21
Latest release
3.6.6
License
MIT
Activity
stale

Checked today - source: GitHub (MindFlavor/prometheus_wireguard_exporter)

Resources & Compatibility

Requirements not published yet.

First-install notes

  • Check the exporter shows UP After starting Prometheus, check the targets API, which lists the servers Prometheus is scraping, and make sure your WireGuard exporter is UP. If it says DOWN, Prometheus can't reach it, so no metrics will show. source
  • Keep scrape timeout below interval In Prometheus's main config file, the global section has scrape_interval and scrape_timeout; keep the timeout shorter than the interval. If not, Prometheus rejects the config and won't start scraping. source
  • Prometheus API normally uses 9090 The example API call uses port 9090, which is the usual local port for Prometheus. If you can't reach the API, check that port or your firewall before changing the exporter. source
  • Add the exporter as a Prometheus scrape target The Unraid plugin serves metrics at http://YOUR_UNRAID_IP:9586/metrics. In your Prometheus configuration, add YOUR_UNRAID_IP:9586 as a scrape target so the exporter appears as UP. source

Fetched 48 days ago - each note links to its source

Alternatives (12)

  • Amazon CloudWatch - Amazon CloudWatch is a monitoring service for AWS cloud resources and the applications running on AWS.
  • Better Stack - AI-driven monitoring platform providing incident management, real-time logs, uptime, traces, error tracking, infrastructure analytics, and…
  • Datadog - Datadog Agent is an on-host monitoring agent that collects metrics, logs, and traces from hosts, containers, and Kubernetes clusters and se…
  • DeepFlow - Unify your cloud-native monitoring with zero-code eBPF, advanced profiling, and 10x storage efficiency.
  • Grafana Loki - Grafana Loki is an open-source log aggregation system.
  • Graylog - Graylog is a centralized log management platform built on open standards for capturing, storing, and analyzing terabytes of machine data in…
  • InfluxDB - InfluxDB is an open source time series database with no external dependencies.
  • Kibana - Kibana is the data visualization layer for querying, analyzing, and managing data stored in Elasticsearch.
  • New Relic - Pinpoint and solve performance issues in your Ruby, Java, .NET, PHP and Python apps with real user, application and server monitoring.
  • Prometheus - Prometheus is a systems and service monitoring system.
  • Splunk - Splunk is a self-hosted platform for collecting, indexing, searching, and analyzing log and security data, helping homelabbers and operatio…
  • VictoriaMetrics - VictoriaMetrics is a fast, cost-effective, and scalable open-source time-series database that stores long-term monitoring metrics, accepts…

Checked 40 days ago - source: AlternativeTo

Common questions

Which WireGuard information does the exporter expose to Prometheus?

It exports the results of wg show all, or the results for a single interface if you specify a config file. The output is converted into a format Prometheus can query.

Does the exporter need its own separate configuration file?

No. It uses the existing WireGuard configuration files, so the setup only needs the /etc/wireguard directory mapped in.

What Prometheus config setting can stop scraping the exporter?

Keep scrape_timeout shorter than scrape_interval in the global section. If the timeout is not shorter, Prometheus rejects the configuration and won't start scraping.

Is there a ready-made Grafana dashboard for this exporter?

Yes. Grafana has a WireGuard dashboard for the Rust-based WireGuard exporter.

Answers sourced from github.com, github.com, grafana.com, www.mo4tech.com

Community

Collected 48 days ago - public community threads