WireGuard
WireGuard
Plugin: go.d.plugin Module: wireguard
Overview
This collector monitors WireGuard VPN devices and peers traffic.
It connects to the local WireGuard instance using wireguard-go client.
This collector is supported on all platforms.
This collector supports collecting metrics from multiple instances of this integration, including remote instances.
This collector requires the CAP_NET_ADMIN capability, but it is set automatically during installation, so no manual configuration is needed.
Default Behavior
Auto-Detection
It automatically detects instances running on localhost.
Limits
Doesn’t work if Netdata or WireGuard is installed in the container.
Performance Impact
The default configuration for this integration is not expected to impose a significant performance impact on the system.
Setup
Prerequisites
No action required.
Configuration
File
The configuration file name for this integration is go.d/wireguard.conf.
You can edit the configuration file using the edit-config script from the
Netdata config directory.
cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata
sudo ./edit-config go.d/wireguard.conf
Options
The following options can be defined globally: update_every, autodetection_retry.
| Name | Description | Default | Required |
|---|---|---|---|
| update_every | Data collection frequency. | 1 | False |
| autodetection_retry | Recheck interval in seconds. Zero means no recheck will be scheduled. | 0 | False |
Examples
There are no configuration examples.
Metrics
Metrics grouped by scope.
The scope defines the instance that the metric belongs to. An instance is uniquely identified by a set of labels.
Per device
These metrics refer to the VPN network interface.
Labels:
| Label | Description |
|---|---|
| device | VPN network interface |
Metrics:
| Metric | Dimensions | Unit |
|---|---|---|
| wireguard.device_network_io | receive, transmit | B/s |
| wireguard.device_peers | peers | peers |
Per peer
These metrics refer to the VPN peer.
Labels:
| Label | Description |
|---|---|
| device | VPN network interface |
| public_key | Public key of a peer |
Metrics:
| Metric | Dimensions | Unit |
|---|---|---|
| wireguard.peer_network_io | receive, transmit | B/s |
| wireguard.peer_latest_handshake_ago | time | seconds |
Alerts
There are no alerts configured by default for this integration.
Troubleshooting
Debug Mode
To troubleshoot issues with the wireguard collector, run the go.d.plugin with the debug option enabled. The output
should give you clues as to why the collector isn’t working.
-
Navigate to the
plugins.ddirectory, usually at/usr/libexec/netdata/plugins.d/. If that’s not the case on your system, opennetdata.confand look for thepluginssetting under[directories].cd /usr/libexec/netdata/plugins.d/ -
Switch to the
netdatauser.sudo -u netdata -s -
Run the
go.d.pluginto debug the collector:./go.d.plugin -d -m wireguard