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

     1  plugin_name: go.d.plugin
     2  modules:
     3    - meta:
     4        id: collector-go.d.plugin-wireguard
     5        plugin_name: go.d.plugin
     6        module_name: wireguard
     7        monitored_instance:
     8          name: WireGuard
     9          link: https://www.wireguard.com/
    10          categories:
    11            - data-collection.vpns
    12          icon_filename: wireguard.svg
    13        keywords:
    14          - wireguard
    15          - vpn
    16          - security
    17        most_popular: false
    18        info_provided_to_referring_integrations:
    19          description: ""
    20        related_resources:
    21          integrations:
    22            list: []
    23      overview:
    24        data_collection:
    25          metrics_description: |
    26            This collector monitors WireGuard VPN devices and peers traffic.
    27          method_description: |
    28            It connects to the local WireGuard instance using [wireguard-go client](https://github.com/WireGuard/wireguard-go).
    29        default_behavior:
    30          auto_detection:
    31            description: |
    32              It automatically detects instances running on localhost.
    33          limits:
    34            description: |
    35              Doesn't work if Netdata or WireGuard is installed in the container.
    36          performance_impact:
    37            description: ""
    38        additional_permissions:
    39          description: |
    40            This collector requires the CAP_NET_ADMIN capability, but it is set automatically during installation, so no manual configuration is needed.
    41        multi_instance: true
    42        supported_platforms:
    43          include: []
    44          exclude: []
    45      setup:
    46        prerequisites:
    47          list: []
    48        configuration:
    49          file:
    50            name: go.d/wireguard.conf
    51          options:
    52            description: |
    53              The following options can be defined globally: update_every, autodetection_retry.
    54            folding:
    55              title: Config options
    56              enabled: true
    57            list:
    58              - name: update_every
    59                description: Data collection frequency.
    60                default_value: 1
    61                required: false
    62              - name: autodetection_retry
    63                description: Recheck interval in seconds. Zero means no recheck will be scheduled.
    64                default_value: 0
    65                required: false
    66          examples:
    67            folding:
    68              title: Config
    69              enabled: true
    70            list: []
    71      troubleshooting:
    72        problems:
    73          list: []
    74      alerts: []
    75      metrics:
    76        folding:
    77          title: Metrics
    78          enabled: false
    79        description: ""
    80        availability: []
    81        scopes:
    82          - name: device
    83            description: These metrics refer to the VPN network interface.
    84            labels:
    85              - name: device
    86                description: VPN network interface
    87            metrics:
    88              - name: wireguard.device_network_io
    89                description: Device traffic
    90                unit: B/s
    91                chart_type: area
    92                dimensions:
    93                  - name: receive
    94                  - name: transmit
    95              - name: wireguard.device_peers
    96                description: Device peers
    97                unit: peers
    98                chart_type: line
    99                dimensions:
   100                  - name: peers
   101          - name: peer
   102            description: These metrics refer to the VPN peer.
   103            labels:
   104              - name: device
   105                description: VPN network interface
   106              - name: public_key
   107                description: Public key of a peer
   108            metrics:
   109              - name: wireguard.peer_network_io
   110                description: Peer traffic
   111                unit: B/s
   112                chart_type: area
   113                dimensions:
   114                  - name: receive
   115                  - name: transmit
   116              - name: wireguard.peer_latest_handshake_ago
   117                description: Peer time elapsed since the latest handshake
   118                unit: seconds
   119                chart_type: line
   120                dimensions:
   121                  - name: time