wireguard

package

v0.0.0-...-6ade924 Latest Latest Go to latest Published: Oct 8, 2022 License: GPL-3.0 Imports: 6 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/bflanigan-sfdc/go.d.plugin

README ¶

WireGuard monitoring with Netdata

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

This module monitors WireGuard VPN network interfaces and peers traffic.

Requirements

Grant CAP_NET_ADMIN capability to go.d.plugin.

sudo setcap CAP_NET_ADMIN+epi <INSTALL_PREFIX>/usr/libexec/netdata/plugins.d/go.d.plugin

Metrics

All metrics have "wireguard." prefix.

Metric	Scope	Dimensions	Units
device_peers	device	peers	peers
device_network_io	device	receive, transmit	B/s
peer_network_io	peer	receive, transmit	B/s
peer_latest_handshake_ago	peer	time	seconds

Configuration

No configuration needed.

Troubleshooting

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