README
¶
OpenVPN collector
Overview
OpenVPN is an open-source commercial software that implements virtual private network techniques to create secure point-to-point or site-to-site connections in routed or bridged configurations and remote access facilities.
This collector parses server log files and provides summary and per user metrics.
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.
global
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 |
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 |
Setup
Prerequisites
No action required.
Configuration
File
The configuration file name is go.d/openvpn_status_log.conf.
The file format is YAML. Generally, the format is:
update_every: 1
autodetection_retry: 0
jobs:
- name: some_name1
- name: some_name1
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_status_log.conf
Options
The following options can be defined globally: update_every, autodetection_retry.
Config options
| Name | Description | Default | Required |
|---|---|---|---|
| update_every | Data collection frequency. | 1 | |
| autodetection_retry | Re-check interval in seconds. Zero means not to schedule re-check. | 0 | |
| log_path | Path to status log. | /var/log/openvpn/status.log | yes |
| per_user_stats | User selector. Determines which user metrics will be collected. |
Metrics of users matching the selector will be collected.
- Logic: (pattern1 OR pattern2) AND !(pattern3 or pattern4)
- Pattern syntax: matcher.
- Syntax:
per_user_stats: includes: - pattern1 - pattern2 excludes: - pattern3 - pattern4
Examples
Collect metrics of all users.
Config
jobs:
- name: local
per_user_stats:
includes:
- "* *"
Troubleshooting
Debug mode
To troubleshoot issues with the openvpn_status_log 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.ddirectory, usually at/usr/libexec/netdata/plugins.d/. If that's not the case on your system, opennetdata.confand look for thepluginssetting under[directories].cd /usr/libexec/netdata/plugins.d/ -
Switch to the
netdatauser.sudo -u netdata -s -
Run the
go.d.pluginto debug the collector:./go.d.plugin -d -m openvpn_status_log
Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Config ¶
type Config struct {
LogPath string `yaml:"log_path"`
PerUserStats matcher.SimpleExpr `yaml:"per_user_stats"`
}
type OpenVPNStatusLog ¶
type OpenVPNStatusLog struct {
module.Base
Config `yaml:",inline"`
// contains filtered or unexported fields
}
func New ¶
func New() *OpenVPNStatusLog
func (OpenVPNStatusLog) Charts ¶
func (o OpenVPNStatusLog) Charts() *module.Charts
func (*OpenVPNStatusLog) Check ¶
func (o *OpenVPNStatusLog) Check() bool
func (*OpenVPNStatusLog) Cleanup ¶
func (o *OpenVPNStatusLog) Cleanup()
func (*OpenVPNStatusLog) Collect ¶
func (o *OpenVPNStatusLog) Collect() map[string]int64
func (*OpenVPNStatusLog) Init ¶
func (o *OpenVPNStatusLog) Init() bool
Source Files