blob: fbe3ff610031ab56465487f0711327e7dd1ac329 (
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
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
|
plugin_name: go.d.plugin
modules:
- meta:
id: collector-go.d.plugin-openvpn_status_log
plugin_name: go.d.plugin
module_name: openvpn_status_log
monitored_instance:
name: OpenVPN status log
link: https://openvpn.net/
icon_filename: openvpn.svg
categories:
- data-collection.vpns
keywords:
- openvpn
- vpn
related_resources:
integrations:
list: []
info_provided_to_referring_integrations:
description: ""
most_popular: false
overview:
data_collection:
metrics_description: |
This collector monitors OpenVPN server.
It parses server log files and provides summary and per user metrics.
method_description: ""
supported_platforms:
include: []
exclude: []
multi_instance: true
additional_permissions:
description: ""
default_behavior:
auto_detection:
description: ""
limits:
description: ""
performance_impact:
description: ""
setup:
prerequisites:
list: []
configuration:
file:
name: go.d/openvpn_status_log.conf
options:
description: |
The following options can be defined globally: update_every, autodetection_retry.
folding:
title: Config options
enabled: true
list:
- name: update_every
description: Data collection frequency.
default_value: 1
required: false
- name: autodetection_retry
description: Recheck interval in seconds. Zero means no recheck will be scheduled.
default_value: 0
required: false
- name: log_path
description: Path to status log.
default_value: /var/log/openvpn/status.log
required: true
- name: per_user_stats
description: User selector. Determines which user metrics will be collected.
default_value: ""
required: false
details: |
Metrics of users matching the selector will be collected.
- Logic: (pattern1 OR pattern2) AND !(pattern3 or pattern4)
- Pattern syntax: [matcher](https://github.com/netdata/netdata/tree/master/src/go/collectors/go.d.plugin/pkg/matcher#supported-format).
- Syntax:
```yaml
per_user_stats:
includes:
- pattern1
- pattern2
excludes:
- pattern3
- pattern4
```
examples:
folding:
title: Config
enabled: true
list:
- name: With user metrics
description: Collect metrics of all users.
config: |
jobs:
- name: local
per_user_stats:
includes:
- "* *"
troubleshooting:
problems:
list: []
alerts: []
metrics:
folding:
title: Metrics
enabled: false
description: ""
availability: []
scopes:
- name: global
description: These metrics refer to the entire monitored application.
labels: []
metrics:
- name: openvpn.active_clients
description: Total Number Of Active Clients
unit: clients
chart_type: line
dimensions:
- name: clients
- name: openvpn.total_traffic
description: Total Traffic
unit: kilobits/s
chart_type: area
dimensions:
- name: in
- name: out
- name: user
description: These metrics refer to the VPN user.
labels:
- name: username
description: VPN username
metrics:
- name: openvpn.user_traffic
description: User Traffic
unit: kilobits/s
chart_type: area
dimensions:
- name: in
- name: out
- name: openvpn.user_connection_time
description: User Connection Time
unit: seconds
chart_type: line
dimensions:
- name: time
|
