mdlayher/wireguard_exporter mdlayher/wireguard_exporter

  • This repository has been archived on 29/Jan/2024
  • Stars
    star
    116
  • Rank 303,894 (Top 6 %)
  • Language
    Go
  • License
    MIT License
  • Created over 5 years ago
  • Updated 12 months ago
Twitter logo Share LinkedIn logo Share Facebook logo Share
mdlayher/wireguard_exporter
github

mdlayher

Reviews

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Repository Details

Command wireguard_exporter implements a Prometheus exporter for WireGuard devices. MIT Licensed.

wireguard_exporter builds.sr.ht status GoDoc Go Report Card

Command wireguard_exporter implements a Prometheus exporter for WireGuard devices. MIT Licensed.

Usage

Use the -h flag to see full usage:

$ wireguard_exporter -h
Usage of wireguard_exporter:
  -metrics.addr string
        address for WireGuard exporter (default ":9586")
  -metrics.path string
        URL path for surfacing collected metrics (default "/metrics")
  -wireguard.peer-file string
        optional: path to TOML friendly peer names mapping file; takes priority over -wireguard.peer-names
  -wireguard.peer-names string
        optional: comma-separated list of colon-separated public keys and friendly peer names, such as: "keyA:foo,keyB:bar"

For simple deployments, specifying peer name mappings on the command line may be sufficient:

$ wireguard_exporter -wireguard.peer-names VWRsPtbdGtcNyaQ+cFAZfZnYL05uj+XINQS6yQY5gQ8=:foo

For larger deployments, you can also specify a TOML file of friendly peer name mappings, which will supersede any command line flag mappings.

[[peer]]
public_key = "VWRsPtbdGtcNyaQ+cFAZfZnYL05uj+XINQS6yQY5gQ8="
name = "foo"

[[peer]]
public_key = "UvwWyMQ1ckLEG82Qdooyr0UzJhqOlzzcx90DXuwMTDA="
name = "bar"
$ wireguard_exporter -wireguard.peer-file /etc/wireguard/peers.toml

Example

This exporter exposes metrics about each configured WireGuard device and its peers, using any device implementation supported by wgctrl-go.

$ curl -s http://localhost:9586/metrics | grep wireguard
# HELP wireguard_device_info Metadata about a device.
# TYPE wireguard_device_info gauge
wireguard_device_info{device="wg0",public_key="QwAmAD1v4wMIX/0gKJbr9hv1o3YX0YTk7Mdj0L4dylI="} 1
# HELP wireguard_peer_allowed_ips_info Metadata about each of a peer's allowed IP subnets for a given device.
# TYPE wireguard_peer_allowed_ips_info gauge
wireguard_peer_allowed_ips_info{allowed_ips="192.168.20.0/24",device="wg0",family="IPv4",public_key="UvwWyMQ1ckLEG82Qdooyr0UzJhqOlzzcx90DXuwMTDA="} 1
wireguard_peer_allowed_ips_info{allowed_ips="fd9e:1a04:f01d:20::/64",device="wg0",family="IPv6",public_key="UvwWyMQ1ckLEG82Qdooyr0UzJhqOlzzcx90DXuwMTDA="} 1
# HELP wireguard_peer_info Metadata about a peer. The public_key label on peer metrics refers to the peer's public key; not the device's public key.
# TYPE wireguard_peer_info gauge
wireguard_peer_info{device="wg0",endpoint="",name="foo",public_key="VWRsPtbdGtcNyaQ+cFAZfZnYL05uj+XINQS6yQY5gQ8="} 1
wireguard_peer_info{device="wg0",endpoint="[fd9e:1a04:f01d:20:e5c2:7b69:90d8:ca45]:49203",name="bar",public_key="UvwWyMQ1ckLEG82Qdooyr0UzJhqOlzzcx90DXuwMTDA="} 1
# HELP wireguard_peer_last_handshake_seconds UNIX timestamp for the last handshake with a given peer.
# TYPE wireguard_peer_last_handshake_seconds gauge
wireguard_peer_last_handshake_seconds{device="wg0",public_key="UvwWyMQ1ckLEG82Qdooyr0UzJhqOlzzcx90DXuwMTDA="} 1.588274629e+09
wireguard_peer_last_handshake_seconds{device="wg0",public_key="VWRsPtbdGtcNyaQ+cFAZfZnYL05uj+XINQS6yQY5gQ8="} 0
# HELP wireguard_peer_receive_bytes_total Number of bytes received from a given peer.
# TYPE wireguard_peer_receive_bytes_total counter
wireguard_peer_receive_bytes_total{device="wg0",public_key="UvwWyMQ1ckLEG82Qdooyr0UzJhqOlzzcx90DXuwMTDA="} 76728
wireguard_peer_receive_bytes_total{device="wg0",public_key="VWRsPtbdGtcNyaQ+cFAZfZnYL05uj+XINQS6yQY5gQ8="} 0
# HELP wireguard_peer_transmit_bytes_total Number of bytes transmitted to a given peer.
# TYPE wireguard_peer_transmit_bytes_total counter
wireguard_peer_transmit_bytes_total{device="wg0",public_key="UvwWyMQ1ckLEG82Qdooyr0UzJhqOlzzcx90DXuwMTDA="} 76200
wireguard_peer_transmit_bytes_total{device="wg0",public_key="VWRsPtbdGtcNyaQ+cFAZfZnYL05uj+XINQS6yQY5gQ8="} 0

Sample queries

Get the receive and transmit rates and last handshake of individual peers, and enable querying on both the WireGuard device name and the peer's friendly name:

irate(wireguard_peer_receive_bytes_total[5m]) * on (public_key, device) group_left(name) wireguard_peer_info * on (instance) group_left(device) wireguard_device_info

irate(wireguard_peer_transmit_bytes_total[5m]) * on (public_key, device) group_left(name) wireguard_peer_info * on (instance) group_left(device) wireguard_device_info

time()-(wireguard_peer_last_handshake_seconds * on (public_key, device) group_left(name) wireguard_peer_info * on (instance) group_left(device) wireguard_device_info)

Grafana Dashboard

You can view your data using this Grafana Dashboard using Prometheus as source.

Grafana Dashboard

Build Binary

cd cmd/wireguard_exporter/
go build .
mv wireguard_exporter /usr/local/bin/

Add service file for systemd

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

[Service]
Type=simple
Restart=always
ExecStart=/usr/local/bin/wireguard_exporter

[Install]
WantedBy=multi-user.target

Load new service and enable autostart:

systemctl daemon-reload
systemctl enable wireguard-exporter.service

Add scraping config to prometheus

In /etc/prometheus/prometheus.yml add following config to the section scrape_configs: :

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

More Repositories

1

netlink

Package netlink provides low-level access to Linux netlink sockets (AF_NETLINK). MIT Licensed.
Go
876
star
2

raw

Package raw enables reading and writing data at the device driver level for a network interface. MIT Licensed.
Go
423
star
3

waveform

Go package capable of generating waveform images from audio streams. MIT Licensed.
Go
355
star
4

arp

Package arp implements the ARP protocol, as described in RFC 826. MIT Licensed.
Go
350
star
5

vsock

Package vsock provides access to Linux VM sockets (AF_VSOCK) for communication between a hypervisor and its virtual machines. MIT Licensed.
Go
331
star
6

ethernet

Package ethernet implements marshaling and unmarshaling of IEEE 802.3 Ethernet II frames and IEEE 802.1Q VLAN tags. MIT Licensed.
Go
271
star
7

wifi

Package wifi provides access to IEEE 802.11 WiFi device actions and statistics. MIT Licensed.
Go
258
star
8

unifi_exporter

Prometheus exporter that exposes metrics from a Ubiquiti UniFi Controller and UniFi devices. MIT Licensed.
Go
255
star
9

ndp

Package ndp implements the Neighbor Discovery Protocol, as described in RFC 4861. MIT Licensed.
Go
217
star
10

corerad

CoreRAD is an extensible and observable IPv6 Neighbor Discovery Protocol router advertisement daemon. Apache 2.0 Licensed.
Go
147
star
11

apcupsd_exporter

Prometheus exporter that exposes metrics from apcupsd's NIS. MIT Licensed.
Go
142
star
12

schedgroup

Package schedgroup provides a goroutine worker pool which schedules tasks to be performed at or after a specified time. MIT Licensed.
Go
131
star
13

consrv

Command consrv is a SSH to serial console bridge server, originally designed for deployment on gokrazy.org devices. Apache 2.0 Licensed.
Go
129
star
14

wavepipe

Cross-platform media server, written in Go. MIT Licensed.
Go
110
star
15

goat

Goat: Go Awesome Tracker. BitTorrent tracker implementation, written in Go. MIT Licensed.
Go
92
star
16

wol

Package wol implements a Wake-on-LAN client. MIT Licensed.
Go
90
star
17

packet

Package packet provides access to Linux packet sockets (AF_PACKET). MIT Licensed.
Go
85
star
18

homelab

Configuration management for Matt Layher's machines. MIT Licensed.
Nix
82
star
19

dhcp6

Package dhcp6 implements a DHCPv6 server, as described in RFC 3315. MIT Licensed.
Go
77
star
20

socket

Package socket provides a low-level network connection type which integrates with Go's runtime network poller to provide asynchronous I/O and deadline support. MIT Licensed.
Go
74
star
21

talks

Talks by Matt Layher. MIT Licensed.
Go
63
star
22

unifi

Package unifi implements a client for the Ubiquiti UniFi Controller v4 and v5 API. MIT Licensed.
Go
59
star
23

ethtool

Package ethtool allows control of the Linux ethtool generic netlink interface. MIT Licensed.
Go
59
star
24

taskstats

Package taskstats provides access to Linux's taskstats interface, for sending per-task and per-process statistics from the kernel to userspace. MIT Licensed.
Go
59
star
25

genetlink

Package genetlink implements generic netlink interactions and data types. MIT Licensed.
Go
53
star
26

apcupsd

Package apcupsd provides a client for the apcupsd Network Information Server (NIS). MIT Licensed.
Go
42
star
27

sdnotify

Package sdnotify implements systemd readiness notifications as described in https://www.freedesktop.org/software/systemd/man/sd_notify.html. MIT Licensed.
Go
40
star
28

rtorrent_exporter

Prometheus exporter that exposes metrics from rTorrent. MIT Licensed.
Go
39
star
29

xdp

Package xdp provides access to Linux userspace XDP sockets (AF_XDP). MIT Licensed.
Go
38
star
30

keylight

Package keylight allows control of Elgato Key Light devices. MIT Licensed.
Go
30
star
31

lldp

Package lldp implements marshaling and unmarshaling of IEEE 802.1AB Link Layer Discovery Protocol frames. MIT Licensed.
Go
30
star
32

icmpx

Package icmpx provides low-level ICMPv4 (IPPROTO_ICMP) and ICMPv6 (IPPROTO_ICMPV6) raw socket support for Linux. MIT Licensed.
Go
29
star
33

prombolt

Package prombolt provides a Prometheus metrics collector for Bolt databases. MIT Licensed.
Go
29
star
34

wgipam

Command wgipamd implements an IP Address Management (IPAM) daemon for dynamic IP address assignment to WireGuard peers, using the wg-dynamic protocol. Apache 2.0 Licensed.
Go
28
star
35

untappd

Package untappd provides an Untappd APIv4 client, written in Go. MIT Licensed.
Go
25
star
36

watchdog

Package watchdog implements control of hardware watchdog devices. MIT Licensed.
Go
25
star
37

netx

A collection of small Go networking packages. MIT Licensed.
Go
24
star
38

lmsensors

Package lmsensors provides access to Linux monitoring sensors data, such as temperatures, voltage, and fan speeds. MIT Licensed.
Go
22
star
39

obd

OBD-II class for vehicle self-diagnostics, written in PHP
PHP
20
star
40

block

Package block enables programmatic access to block devices. MIT Licensed.
Go
20
star
41

kobject

Package kobject provides access to Linux kobject userspace events. MIT Licensed.
Go
20
star
42

php-bloomd

PHP 5.4+ class for interacting with a bloomd server. MIT Licensed.
PHP
20
star
43

scanrs

A port scanner written in Rust, as an exercise to learn more about Rust! MIT Licensed.
Rust
19
star
44

taggolib

taggolib is a Go package which provides read-only access to metadata contained in various audio formats. MIT Licensed.
Go
17
star
45

networkd

Package networkd enables control of systemd-networkd using D-Bus. MIT Licensed.
Go
16
star
46

mptcp

Package mptcp provides detection functionality for active, multipath TCP connections from a remote client to the current host. MIT Licensed.
Go
16
star
47

monkey-rs

A Rust implementation of the Monkey programming language from https://interpreterbook.com/. MIT Licensed.
Rust
16
star
48

ospf3

Package ospf3 implements OSPFv3 (OSPF for IPv6) as described in RFC5340. MIT Licensed.
Go
15
star
49

hdhomerun_exporter

Command hdhomerun_exporter implements a Prometheus exporter for SiliconDust HDHomeRun devices. MIT Licensed.
Go
15
star
50

edgemax

Package edgemax implements a client for Ubiquiti EdgeMAX devices. MIT Licensed.
Go
14
star
51

alg

Package alg provides access to Linux AF_ALG sockets for communication with the Linux kernel crypto API. MIT Licensed.
Go
14
star
52

zedhook

zedhook provides a ZEDLET (ZFS Event Daemon Linkage for Executable Tasks) and zevent receiver server to monitor and log ZFS events produced by ZED. Apache 2.0 Licensed.
Go
14
star
53

wgdynamic-go

Package wgdynamic implements a client and server for the the wg-dynamic protocol. MIT Licensed.
Go
13
star
54

netstate

Package netstate provides notification of network interface state changes. MIT Licensed.
Go
13
star
55

rfc4193

Package rfc4193 implements Unique Local IPv6 Unicast Address prefix generation, as described in RFC 4193. MIT Licensed.
13
star
56

subfs

Experimental FUSE filesystem for the Subsonic media server, written in Go. MIT Licensed.
Go
13
star
57

wifiqr

Package wifiqr implements support for generating WiFi QR codes. MIT Licensed.
Go
12
star
58

php-serial

PHP class utilizing Direct IO to interact with a RS232 serial port
PHP
12
star
59

aoe

Package aoe implements an ATA over Ethernet server, as described in the AoEr11 specification. MIT Licensed.
Go
12
star
60

smbios-rs

Provides detection and access to System Management BIOS (SMBIOS) and Desktop Management Interface (DMI) data and structures. MIT Licensed.
Rust
12
star
61

edgemax_exporter

Prometheus exporter that exposes metrics from Ubiquiti EdgeMAX devices. MIT Licensed.
Go
12
star
62

vxlan

Package vxlan implements marshaling and unmarshaling of Virtual eXtensible Local Area Network (VXLAN) frames, as described in RFC 7348. MIT Licensed.
Go
11
star
63

tftp

Package tftp implements a TFTP server, as described in RFC 1350. MIT Licensed.
Go
10
star
64

nbd-rs

An asynchronous Rust client and server implementation of the Network Block Device (NBD) protocol. MIT Licensed.
Rust
10
star
65

devlink

Package devlink provides access to Linux's devlink interface. MIT Licensed.
Go
9
star
66

hdhomerun

Package hdhomerun enables interacting with SiliconDust HDHomeRun devices. MIT Licensed.
Go
9
star
67

ordered

Package ordered implements data structures which maintain consistent ordering of inserted elements.
Go
9
star
68

cryptonl

Package cryptonl provides access to the Linux kernel crypto API's netlink interface. MIT Licensed.
Go
9
star
69

metricslite

Package metricslite implements a lightweight, testable metrics interface focused on Prometheus metrics. MIT Licensed.
Go
9
star
70

rtorrent

Package rtorrent implements a client for rTorrent. MIT Licensed.
Go
8
star
71

atmodem

Package atmodem provides a high-level interface for controlling modems using the AT command set. MIT Licensed.
Go
8
star
72

modemmanager

Package modemmanager enables Go programs to control ModemManager and its devices using D-Bus. MIT Licensed.
Go
8
star
73

yamlnetlink

Package yamlnetlink provides support for parsing YAML netlink specifications. MIT Licensed.
Go
7
star
74

eui64

Package eui64 enables creation and parsing of Modified EUI-64 format interface identifiers, as described in RFC 4291, Section 2.5.1. MIT Licensed.
7
star
75

arris_exporter

Command arris_exporter implements a Prometheus exporter for Arris cable modem devices. MIT Licensed.
Go
6
star
76

lmsensors_exporter

Prometheus exporter that exposes lm_sensors sensor metrics. MIT Licensed.
Go
6
star
77

quota

Package quota provides access to Linux quota netlink notifications. MIT Licensed.
Go
6
star
78

mpdsub

Command mpdsubd provides a Subsonic HTTP API bridge to a backing MPD server. MIT Licensed.
Go
6
star
79

promtest

Package promtest provides helpers for testing applications which export Prometheus metrics. MIT Licensed.
Go
6
star
80

flightdeck

flightdeck is an experiment to create a highly customizable hardware/software interface for live streaming and other computer activities. Apache 2.0 Licensed.
Go
6
star
81

gosubsonic

Subsonic client library, written in Go. MIT Licensed.
Go
5
star
82

kcm

Package kcm provides access to Linux Kernel Connection Multiplexor sockets (AF_KCM). MIT Licensed.
Go
5
star
83

sshttp

Package sshttp provides functionality that enables some functionality of Go's net/http package to be used with SSH servers using SFTP. MIT Licensed.
Go
5
star
84

geneve

Package geneve implements marshaling and unmarshaling of Generic Network Virtualization Encapsulation (Geneve) headers, as described in the IETF internet draft: https://tools.ietf.org/html/draft-ietf-nvo3-geneve-02. MIT Licensed.
Go
4
star
85

modemmanager_exporter

Command modemmanager_exporter implements a Prometheus exporter for ModemManager and its devices. MIT Licensed.
Go
4
star
86

multinet

Package multinet allows combining multiple package net types into one. MIT Licensed.
4
star
87

pidfd

Package pidfd provides access to Linux process file descriptors. MIT Licensed.
Go
4
star
88

imagegrid

Package imagegrid enables composing one or more images into a single image, using a tiled grid pattern. MIT Licensed.
Go
4
star
89

launchpad

Package launchpad provides Go support for Novation Launchpad MIDI devices. MIT Licensed.
Go
4
star
90

fibrechannel

Package fibrechannel implements marshaling and unmarshaling of Fibre Channel frames. MIT Licensed.
Go
3
star
91

godigraph

Directed graph or "digraph" implementation, written in Go. MIT Licensed.
Go
3
star
92

netconsole

Package netconsole enables capture and processing of logs generated by the netconsole Linux kernel module. MIT Licensed.
Go
3
star
93

neighbor

Package neighbor enables network neighbor detection using operating system specific facilities. MIT Licensed.
Go
3
star
94

misc

A collection of miscellaneous pieces of code, saved for future reference and use. Feel free to use and modify anything in this repository.
PHP
3
star
95

mdlayher.com

Matt Layher's personal static website. MIT Licensed.
Go
3
star
96

p4

Package p4 provides a variety of facilities for lexing, parsing, and manipulating P4 source code. MIT Licensed.
Go
2
star
97

netconsoled

Command netconsoled provides a server that can receive and process logs generated by the netconsole Linux kernel module. MIT Licensed.
Go
2
star
98

arris

Package arris gathers statistics from the web interface of Arris cable modems. MIT Licensed.
Go
2
star
99

tapcam

Brewery tap camera image upload and display system.
Go
2
star
100

flac-rs

A pure Rust FLAC metadata parser, written as an experiment to learn more about Rust.
Rust
2
star