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