blob: b1f583c9bb49a6428446539008d86e245e7d949d (
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
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
|
plugin_name: go.d.plugin
modules:
- meta:
id: collector-go.d.plugin-openvpn
plugin_name: go.d.plugin
module_name: openvpn
monitored_instance:
name: OpenVPN
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 servers.
It uses OpenVPN [Management Interface](https://openvpn.net/community-resources/management-interface/) to collect 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:
- title: Enable in go.d.conf.
description: |
This collector is disabled by default. You need to explicitly enable it in [go.d.conf](https://github.com/netdata/netdata/blob/master/src/go/collectors/go.d.plugin/config/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:
file:
name: go.d/openvpn.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: address
description: Server address in IP:PORT format.
default_value: 127.0.0.1:7505
required: true
- name: timeout
description: Connection, read, and write timeout duration in seconds. The timeout includes name resolution.
default_value: 1
required: false
- 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: Basic
description: A basic example configuration.
config: |
jobs:
- name: local
address: 127.0.0.1:7505
- name: With user metrics
description: Collect metrics of all users.
config: |
jobs:
- name: local
address: 127.0.0.1:7505
per_user_stats:
includes:
- "* *"
- name: Multi-instance
description: |
> **Note**: When you define multiple jobs, their names must be unique.
Collecting metrics from local and remote instances.
config: |
jobs:
- name: local
address: 127.0.0.1:7505
- name: remote
address: 203.0.113.0:7505
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
|
