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

<!--startmeta customediturl: "https://github.com/netdata/netdata/edit/master/src/go/collectors/go.d.plugin/modules/openvpn/README.md" meta_yaml: "https://github.com/netdata/netdata/edit/master/src/go/collectors/go.d.plugin/modules/openvpn/metadata.yaml" sidebar_label: "OpenVPN" 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/openvpn.svg" width="150"/> Plugin: go.d.plugin Module: openvpn <img src="https://img.shields.io/badge/maintained%20by-Netdata-%2300ab44" /> This collector monitors OpenVPN servers. It uses OpenVPN to collect metrics. This collector is supported on all platforms. This collector supports collecting metrics from multiple instances of this integration, including remote instances. This integration doesn't support auto-detection. The default configuration for this integration does not impose any limits on data collection. 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 entire monitored application. This scope has no labels. Metrics: | Metric | Dimensions | Unit | |:|:-|:-| | openvpn.active_clients | clients | clients | | openvpn.total_traffic | in, out | kilobits/s | These metrics refer to the VPN user. Labels: | Label | Description | |:--|:-| | username | VPN username | Metrics: | Metric | Dimensions | Unit | |:|:-|:-| | openvpn.user_traffic | in, out | kilobits/s | | openvpn.userconnectiontime | time | seconds | There are no alerts configured by default for this integration. This collector is disabled by default. You need to explicitly enable it in . From the documentation for the OpenVPN Management Interface: Currently, the OpenVPN daemon can at most support a single management client any one time. It is disabled to not break other tools which use `Management Interface`. The configuration file name for this integration is `go.d/openvpn.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/openvpn.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 | | address | Server address in IP:PORT format. | 127.0.0.1:7505 | yes | | timeout | Connection, read, and write timeout duration in seconds. The timeout includes name resolution. | 1 | no | | peruserstats | User selector. Determines which user metrics will be collected. | | no | </details> A basic example configuration. <details><summary>Config</summary> ```yaml jobs: name: local address: 127.0.0.1:7505 ``` </details> Collect metrics of all users. <details><summary>Config</summary> ```yaml jobs: name: local address: 127.0.0.1:7505 peruserstats: includes: " " ``` </details> Note: When you define multiple jobs, their names must be unique. Collecting metrics from local and remote instances. <details><summary>Config</summary> ```yaml jobs: name: local address: 127.0.0.1:7505 name: remote address: 203.0.113.0:7505 ``` </details> To troubleshoot issues with the `openvpn` 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 openvpn ```