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

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