| 1 | plugin_name: go.d.plugin |
| 2 | modules: |
| 3 | - meta: |
| 4 | id: collector-go.d.plugin-openvpn |
| 5 | plugin_name: go.d.plugin |
| 6 | module_name: openvpn |
| 7 | monitored_instance: |
| 8 | name: OpenVPN |
| 9 | link: https://openvpn.net/ |
| 10 | icon_filename: openvpn.svg |
| 11 | categories: |
| 12 | - data-collection.networking |
| 13 | keywords: |
| 14 | - openvpn |
| 15 | - vpn |
| 16 | related_resources: |
| 17 | integrations: |
| 18 | list: [] |
| 19 | info_provided_to_referring_integrations: |
| 20 | description: "" |
| 21 | overview: |
| 22 | data_collection: |
| 23 | metrics_description: | |
| 24 | This collector monitors OpenVPN servers. |
| 25 | |
| 26 | It uses OpenVPN [Management Interface](https://openvpn.net/community-resources/management-interface/) to collect metrics. |
| 27 | method_description: "" |
| 28 | supported_platforms: |
| 29 | include: [] |
| 30 | exclude: [] |
| 31 | multi_instance: true |
| 32 | additional_permissions: |
| 33 | description: "" |
| 34 | default_behavior: |
| 35 | auto_detection: |
| 36 | description: "" |
| 37 | limits: |
| 38 | description: "" |
| 39 | performance_impact: |
| 40 | description: "" |
| 41 | setup: |
| 42 | prerequisites: |
| 43 | list: |
| 44 | - title: Enable in go.d.conf. |
| 45 | description: | |
| 46 | 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/plugin/go.d/config/go.d.conf). |
| 47 | |
| 48 | From the documentation for the OpenVPN Management Interface: |
| 49 | > Currently, the OpenVPN daemon can at most support a single management client any one time. |
| 50 | |
| 51 | It is disabled to not break other tools which use `Management Interface`. |
| 52 | configuration: |
| 53 | file: |
| 54 | name: go.d/openvpn.conf |
| 55 | options: |
| 56 | description: | |
| 57 | The following options can be defined globally: update_every, autodetection_retry. |
| 58 | folding: |
| 59 | title: Config options |
| 60 | enabled: true |
| 61 | list: |
| 62 | - name: update_every |
| 63 | description: Data collection interval (seconds). |
| 64 | default_value: 1 |
| 65 | required: false |
| 66 | group: Collection |
| 67 | - name: autodetection_retry |
| 68 | description: Autodetection retry interval (seconds). Set 0 to disable. |
| 69 | default_value: 0 |
| 70 | required: false |
| 71 | group: Collection |
| 72 | |
| 73 | - name: address |
| 74 | description: OpenVPN server address (`IP:PORT`). |
| 75 | default_value: 127.0.0.1:7505 |
| 76 | required: true |
| 77 | group: Target |
| 78 | - name: timeout |
| 79 | description: Connection, read, write, and name resolution timeout (seconds). |
| 80 | default_value: 1 |
| 81 | required: false |
| 82 | group: Target |
| 83 | |
| 84 | - name: per_user_stats |
| 85 | description: User selector. Defines which user metrics to collect. |
| 86 | default_value: "" |
| 87 | required: false |
| 88 | group: Filters |
| 89 | details: | |
| 90 | Metrics of users matching the selector will be collected. |
| 91 | |
| 92 | - Logic: (pattern1 OR pattern2) AND !(pattern3 OR pattern4) |
| 93 | - Pattern syntax: [matcher](https://github.com/netdata/netdata/tree/master/src/go/pkg/matcher#supported-format). |
| 94 | - Syntax: |
| 95 | |
| 96 | ```yaml |
| 97 | per_user_stats: |
| 98 | includes: |
| 99 | - pattern1 |
| 100 | - pattern2 |
| 101 | excludes: |
| 102 | - pattern3 |
| 103 | - pattern4 |
| 104 | ``` |
| 105 | |
| 106 | - name: vnode |
| 107 | description: Associates this data collection job with a [Virtual Node](https://learn.netdata.cloud/docs/netdata-agent/configuration/organize-systems-metrics-and-alerts#virtual-nodes). |
| 108 | default_value: "" |
| 109 | required: false |
| 110 | group: Virtual Node |
| 111 | examples: |
| 112 | folding: |
| 113 | title: Config |
| 114 | enabled: true |
| 115 | list: |
| 116 | - name: Basic |
| 117 | description: A basic example configuration. |
| 118 | config: | |
| 119 | jobs: |
| 120 | - name: local |
| 121 | address: 127.0.0.1:7505 |
| 122 | - name: With user metrics |
| 123 | description: Collect metrics of all users. |
| 124 | config: | |
| 125 | jobs: |
| 126 | - name: local |
| 127 | address: 127.0.0.1:7505 |
| 128 | per_user_stats: |
| 129 | includes: |
| 130 | - "* *" |
| 131 | - name: Multi-instance |
| 132 | description: | |
| 133 | > **Note**: When you define multiple jobs, their names must be unique. |
| 134 | |
| 135 | Collecting metrics from local and remote instances. |
| 136 | config: | |
| 137 | jobs: |
| 138 | - name: local |
| 139 | address: 127.0.0.1:7505 |
| 140 | |
| 141 | - name: remote |
| 142 | address: 203.0.113.0:7505 |
| 143 | troubleshooting: |
| 144 | problems: |
| 145 | list: [] |
| 146 | alerts: [] |
| 147 | metrics: |
| 148 | folding: |
| 149 | title: Metrics |
| 150 | enabled: false |
| 151 | description: "" |
| 152 | availability: [] |
| 153 | scopes: |
| 154 | - name: global |
| 155 | description: These metrics refer to the entire monitored application. |
| 156 | labels: [] |
| 157 | metrics: |
| 158 | - name: openvpn.active_clients |
| 159 | description: Total Number Of Active Clients |
| 160 | unit: clients |
| 161 | chart_type: line |
| 162 | dimensions: |
| 163 | - name: clients |
| 164 | - name: openvpn.total_traffic |
| 165 | description: Total Traffic |
| 166 | unit: kilobits/s |
| 167 | chart_type: area |
| 168 | dimensions: |
| 169 | - name: in |
| 170 | - name: out |
| 171 | - name: user |
| 172 | description: These metrics refer to the VPN user. |
| 173 | labels: |
| 174 | - name: username |
| 175 | description: VPN username |
| 176 | metrics: |
| 177 | - name: openvpn.user_traffic |
| 178 | description: User Traffic |
| 179 | unit: kilobits/s |
| 180 | chart_type: area |
| 181 | dimensions: |
| 182 | - name: in |
| 183 | - name: out |
| 184 | - name: openvpn.user_connection_time |
| 185 | description: User Connection Time |
| 186 | unit: seconds |
| 187 | chart_type: line |
| 188 | dimensions: |
| 189 | - name: time |