wireguard

package

v0.55.0 Latest Latest Go to latest Published: Sep 15, 2023 License: GPL-3.0 Imports: 6 Imported by: 1

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/netdata/go.d.plugin

Links

Open Source Insights

README ¶

WireGuard collector

Overview

WireGuard is an extremely simple yet fast and modern VPN that utilizes state-of-the-art cryptography.

This collector monitors WireGuard VPN network interfaces and peers traffic. CAP_NET_ADMIN capability is required. It is set automatically during installation.

Collected 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.

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

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

Setup

Prerequisites

No action required.

Configuration

No configuration required.

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.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].
```
cd /usr/libexec/netdata/plugins.d/
```
Switch to the netdata user.
```
sudo -u netdata -s
```
Run the go.d.plugin to debug the collector:
```
./go.d.plugin -d -m wireguard
```

Documentation ¶

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type WireGuard ¶

type WireGuard struct {
	module.Base
	// contains filtered or unexported fields
}

func New ¶

func New() *WireGuard

func (*WireGuard) Charts ¶

func (w *WireGuard) Charts() *module.Charts

func (*WireGuard) Check ¶

func (w *WireGuard) Check() bool

func (*WireGuard) Cleanup ¶

func (w *WireGuard) Cleanup()

func (*WireGuard) Collect ¶

func (w *WireGuard) Collect() map[string]int64

func (*WireGuard) Init ¶

func (w *WireGuard) Init() bool

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL