Project: Netdata (Observability and Analysis / Observability)
File: wireguard.md

<!--startmeta customediturl: "https://github.com/netdata/netdata/edit/master/src/go/collectors/go.d.plugin/modules/wireguard/README.md" meta_yaml: "https://github.com/netdata/netdata/edit/master/src/go/collectors/go.d.plugin/modules/wireguard/metadata.yaml" sidebar_label: "WireGuard" learn_status: "Published" learnrelpath: "Collecting Metrics/VPNs" most_popular: False message: "DO NOT EDIT THIS FILE DIRECTLY, IT IS GENERATED BY THE COLLECTOR'S metadata.yaml FILE" endmeta--> <img src="https://netdata.cloud/img/wireguard.svg" width="150"/> Plugin: go.d.plugin Module: wireguard <img src="https://img.shields.io/badge/maintained%20by-Netdata-%2300ab44" /> This collector monitors WireGuard VPN devices and peers traffic. It connects to the local WireGuard instance using . 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 CAPNETADMIN capability, but it is set automatically during installation, so no manual configuration is needed. It automatically detects instances running on localhost. Doesn't work if Netdata or WireGuard is installed in the container. The default configuration for this integration is not expected to impose a significant performance impact on the system. Metrics grouped by scope. The scope defines the instance that the metric belongs to. An instance is uniquely identified by a set of labels. These metrics refer to the VPN network interface. Labels: | Label | Description | |:--|:-| | device | VPN network interface | Metrics: | Metric | Dimensions | Unit | |:|:-|:-| | wireguard.devicenetworkio | receive, transmit | B/s | | wireguard.device_peers | peers | peers | 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.peernetworkio | receive, transmit | B/s | | wireguard.peerlatesthandshake_ago | time | seconds | There are no alerts configured by default for this integration. No action required. 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 . ```bash cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata sudo ./edit-config go.d/wireguard.conf ``` The following options can be defined globally: updateevery, autodetectionretry. <details><summary>Config options</summary> | Name | Description | Default | Required | |:-|:--|:-|:--:| | update_every | Data collection frequency. | 1 | no | | autodetection_retry | Recheck interval in seconds. Zero means no recheck will be scheduled. | 0 | no | </details> There are no configuration examples. 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.d` directory, usually at `/usr/libexec/netdata/plugins.d/`. If that's not the case on your system, open `netdata.conf` and look for the `plugins` setting under `[directories]`. ```bash cd /usr/libexec/netdata/plugins.d/ ``` Switch to the `netdata` user. ```bash sudo -u netdata -s ``` Run the `go.d.plugin` to debug the collector: ```bash ./go.d.plugin -d -m wireguard ```