summaryrefslogtreecommitdiffstats
path: root/collectors/python.d.plugin/ovpn_status_log/README.md
blob: 374d1910e24c032c92fd88d4ae4ddda2d2fe54ef (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
<!--
title: "OpenVPN monitoring with Netdata"
custom_edit_url: https://github.com/netdata/netdata/edit/master/collectors/python.d.plugin/ovpn_status_log/README.md
sidebar_label: "OpenVPN"
-->

# OpenVPN monitoring with Netdata

Parses server log files and provides summary (client, traffic) metrics.

## Requirements

-   If you are running multiple OpenVPN instances out of the same directory, MAKE SURE TO EDIT DIRECTIVES which create output files
    so that multiple instances do not overwrite each other's output files.

-   Make sure NETDATA USER CAN READ openvpn-status.log

-   Update_every interval MUST MATCH interval on which OpenVPN writes operational status to log file.

It produces:

1.  **Users** OpenVPN active users

    -   users

2.  **Traffic** OpenVPN overall bandwidth usage in kilobit/s

    -   in
    -   out

## Configuration

Edit the `python.d/ovpn_status_log.conf` configuration file using `edit-config` from the Netdata [config
directory](/docs/configure/nodes.md), which is typically at `/etc/netdata`.

```bash
cd /etc/netdata   # Replace this path with your Netdata config directory, if different
sudo ./edit-config python.d/ovpn_status_log.conf
```

Sample:

```yaml
default
 log_path     : '/var/log/openvpn-status.log'
```

---