@cryptotaxi247 / netdata
Code Commits Issues Pulls Sessions CI/CD
master
master
md 8.79 KB
View source Raw

OpenVPN

Plugin: go.d.plugin Module: openvpn

Overview

This collector monitors OpenVPN servers.

It uses OpenVPN Management Interface to collect metrics.

This collector is supported on all platforms.

This collector supports collecting metrics from multiple instances of this integration, including remote instances.

Default Behavior

Auto-Detection

This integration doesn't support auto-detection.

Limits

The default configuration for this integration does not impose any limits on data collection.

Performance Impact

The default configuration for this integration is not expected to impose a significant performance impact on the system.

Setup

You can configure the openvpn collector in two ways:

Method Best for How to
UI Fast setup without editing files Go to Nodes → Configure this node → Collectors → Jobs, search for openvpn, then click + to add a job.
File If you prefer configuring via file, or need to automate deployments (e.g., with Ansible) Edit go.d/openvpn.conf and add a job.

:::important

UI configuration requires paid Netdata Cloud plan.

:::

Prerequisites

Enable in go.d.conf.

This collector is disabled by default. You need to explicitly enable it in go.d.conf.

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.

Configuration

Options

The following options can be defined globally: update_every, autodetection_retry.

Config options | Group | Option | Description | Default | Required | |:------|:-----|:------------|:--------|:---------:| | **Collection** | update_every | Data collection interval (seconds). | 1 | no | | | autodetection_retry | Autodetection retry interval (seconds). Set 0 to disable. | 0 | no | | **Target** | address | OpenVPN server address (`IP:PORT`). | 127.0.0.1:7505 | yes | | | timeout | Connection, read, write, and name resolution timeout (seconds). | 1 | no | | **Filters** | per_user_stats | User selector. Defines which user metrics to collect. | | no | | **Virtual Node** | vnode | Associates this data collection job with a [Virtual Node](https://learn.netdata.cloud/docs/netdata-agent/configuration/organize-systems-metrics-and-alerts#virtual-nodes). | | no |

via UI

Configure the openvpn collector from the Netdata web interface:

  1. Go to Nodes.
  2. Select the node where you want the openvpn data-collection job to run and click the :gear: (Configure this node). That node will run the data collection.
  3. The Collectors → Jobs view opens by default.
  4. In the Search box, type openvpn (or scroll the list) to locate the openvpn collector.
  5. Click the + next to the openvpn collector to add a new job.
  6. Fill in the job fields, then click Test to verify the configuration and Submit to save.
    • Test runs the job with the provided settings and shows whether data can be collected.
    • If it fails, an error message appears with details (for example, connection refused, timeout, or command execution errors), so you can adjust and retest.

via File

The configuration file name for this integration is go.d/openvpn.conf.

The file format is YAML. Generally, the structure is:

update_every: 1
autodetection_retry: 0
jobs:
  - name: some_name1
  - name: some_name2

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/openvpn.conf
Examples
Basic

A basic example configuration.

Config ```yaml jobs: - name: local address: 127.0.0.1:7505 ```
With user metrics

Collect metrics of all users.

Config ```yaml jobs: - name: local address: 127.0.0.1:7505 per_user_stats: includes: - "* *" ```
Multi-instance

Note: When you define multiple jobs, their names must be unique.

Collecting metrics from local and remote instances.

Config ```yaml jobs: - name: local address: 127.0.0.1:7505 - name: remote address: 203.0.113.0:7505 ```

Alerts

There are no alerts configured by default for this integration.

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 OpenVPN instance

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

Per user

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.user_connection_time time seconds

Troubleshooting

Debug Mode

Important: Debug mode is not supported for data collection jobs created via the UI using the Dyncfg feature.

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].
  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 openvpn

To debug a specific job:

  ./go.d.plugin -d -m openvpn -j jobName

Getting Logs

If you're encountering problems with the openvpn collector, follow these steps to retrieve logs and identify potential issues:

  • Run the command specific to your system (systemd, non-systemd, or Docker container).
  • Examine the output for any warnings or error messages that might indicate issues. These messages should provide clues about the root cause of the problem.

System with systemd

Use the following command to view logs generated since the last Netdata service restart:

journalctl _SYSTEMD_INVOCATION_ID="$(systemctl show --value --property=InvocationID netdata)" --namespace=netdata --grep openvpn

System without systemd

Locate the collector log file, typically at /var/log/netdata/collector.log, and use grep to filter for collector's name:

grep openvpn /var/log/netdata/collector.log

Note: This method shows logs from all restarts. Focus on the latest entries for troubleshooting current issues.

Docker Container

If your Netdata runs in a Docker container named "netdata" (replace if different), use this command:

docker logs netdata 2>&1 | grep openvpn