github.com/netdata/go.d.plugin@v0.58.1/modules/openvpn/metadata.yaml (about)

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