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