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

     1  <!--startmeta
     2  custom_edit_url: "https://github.com/netdata/go.d.plugin/edit/master/modules/openvpn_status_log/README.md"
     3  meta_yaml: "https://github.com/netdata/go.d.plugin/edit/master/modules/openvpn_status_log/metadata.yaml"
     4  sidebar_label: "OpenVPN status log"
     5  learn_status: "Published"
     6  learn_rel_path: "Data Collection/VPNs"
     7  most_popular: False
     8  message: "DO NOT EDIT THIS FILE DIRECTLY, IT IS GENERATED BY THE COLLECTOR'S metadata.yaml FILE"
     9  endmeta-->
    10  
    11  # OpenVPN status log
    12  
    13  
    14  <img src="https://netdata.cloud/img/openvpn.svg" width="150"/>
    15  
    16  
    17  Plugin: go.d.plugin
    18  Module: openvpn_status_log
    19  
    20  <img src="https://img.shields.io/badge/maintained%20by-Netdata-%2300ab44" />
    21  
    22  ## Overview
    23  
    24  This collector monitors OpenVPN server.
    25  
    26  It parses server log files and provides summary and per user metrics.
    27  
    28  
    29  
    30  
    31  This collector is supported on all platforms.
    32  
    33  This collector supports collecting metrics from multiple instances of this integration, including remote instances.
    34  
    35  
    36  ### Default Behavior
    37  
    38  #### Auto-Detection
    39  
    40  This integration doesn't support auto-detection.
    41  
    42  #### Limits
    43  
    44  The default configuration for this integration does not impose any limits on data collection.
    45  
    46  #### Performance Impact
    47  
    48  The default configuration for this integration is not expected to impose a significant performance impact on the system.
    49  
    50  
    51  ## Metrics
    52  
    53  Metrics grouped by *scope*.
    54  
    55  The scope defines the instance that the metric belongs to. An instance is uniquely identified by a set of labels.
    56  
    57  
    58  
    59  ### Per OpenVPN status log instance
    60  
    61  These metrics refer to the entire monitored application.
    62  
    63  This scope has no labels.
    64  
    65  Metrics:
    66  
    67  | Metric | Dimensions | Unit |
    68  |:------|:----------|:----|
    69  | openvpn.active_clients | clients | clients |
    70  | openvpn.total_traffic | in, out | kilobits/s |
    71  
    72  ### Per user
    73  
    74  These metrics refer to the VPN user.
    75  
    76  Labels:
    77  
    78  | Label      | Description     |
    79  |:-----------|:----------------|
    80  | username | VPN username |
    81  
    82  Metrics:
    83  
    84  | Metric | Dimensions | Unit |
    85  |:------|:----------|:----|
    86  | openvpn.user_traffic | in, out | kilobits/s |
    87  | openvpn.user_connection_time | time | seconds |
    88  
    89  
    90  
    91  ## Alerts
    92  
    93  There are no alerts configured by default for this integration.
    94  
    95  
    96  ## Setup
    97  
    98  ### Prerequisites
    99  
   100  No action required.
   101  
   102  ### Configuration
   103  
   104  #### File
   105  
   106  The configuration file name for this integration is `go.d/openvpn_status_log.conf`.
   107  
   108  
   109  You can edit the configuration file using the `edit-config` script from the
   110  Netdata [config directory](https://github.com/netdata/netdata/blob/master/docs/configure/nodes.md#the-netdata-config-directory).
   111  
   112  ```bash
   113  cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata
   114  sudo ./edit-config go.d/openvpn_status_log.conf
   115  ```
   116  #### Options
   117  
   118  The following options can be defined globally: update_every, autodetection_retry.
   119  
   120  
   121  <details><summary>Config options</summary>
   122  
   123  | Name | Description | Default | Required |
   124  |:----|:-----------|:-------|:--------:|
   125  | update_every | Data collection frequency. | 1 | no |
   126  | autodetection_retry | Recheck interval in seconds. Zero means no recheck will be scheduled. | 0 | no |
   127  | log_path | Path to status log. | /var/log/openvpn/status.log | yes |
   128  | per_user_stats | User selector. Determines which user metrics will be collected. |  | no |
   129  
   130  </details>
   131  
   132  #### Examples
   133  
   134  ##### With user metrics
   135  
   136  Collect metrics of all users.
   137  
   138  <details><summary>Config</summary>
   139  
   140  ```yaml
   141  jobs:
   142    - name: local
   143      per_user_stats:
   144        includes:
   145          - "* *"
   146  
   147  ```
   148  </details>
   149  
   150  
   151  
   152  ## Troubleshooting
   153  
   154  ### Debug Mode
   155  
   156  To troubleshoot issues with the `openvpn_status_log` collector, run the `go.d.plugin` with the debug option enabled. The output
   157  should give you clues as to why the collector isn't working.
   158  
   159  - Navigate to the `plugins.d` directory, usually at `/usr/libexec/netdata/plugins.d/`. If that's not the case on
   160    your system, open `netdata.conf` and look for the `plugins` setting under `[directories]`.
   161  
   162    ```bash
   163    cd /usr/libexec/netdata/plugins.d/
   164    ```
   165  
   166  - Switch to the `netdata` user.
   167  
   168    ```bash
   169    sudo -u netdata -s
   170    ```
   171  
   172  - Run the `go.d.plugin` to debug the collector:
   173  
   174    ```bash
   175    ./go.d.plugin -d -m openvpn_status_log
   176    ```
   177  
   178