diff options
author | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-08-26 08:15:20 +0000 |
---|---|---|
committer | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-08-26 08:15:20 +0000 |
commit | 87d772a7d708fec12f48cd8adc0dedff6e1025da (patch) | |
tree | 1fee344c64cc3f43074a01981e21126c8482a522 /src/go/collectors/go.d.plugin/modules/openvpn/metadata.yaml | |
parent | Adding upstream version 1.46.3. (diff) | |
download | netdata-87d772a7d708fec12f48cd8adc0dedff6e1025da.tar.xz netdata-87d772a7d708fec12f48cd8adc0dedff6e1025da.zip |
Adding upstream version 1.47.0.upstream/1.47.0
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'src/go/collectors/go.d.plugin/modules/openvpn/metadata.yaml')
-rw-r--r-- | src/go/collectors/go.d.plugin/modules/openvpn/metadata.yaml | 177 |
1 files changed, 0 insertions, 177 deletions
diff --git a/src/go/collectors/go.d.plugin/modules/openvpn/metadata.yaml b/src/go/collectors/go.d.plugin/modules/openvpn/metadata.yaml deleted file mode 100644 index b1f583c9b..000000000 --- a/src/go/collectors/go.d.plugin/modules/openvpn/metadata.yaml +++ /dev/null @@ -1,177 +0,0 @@ -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 |