| 1 | plugin_name: go.d.plugin |
| 2 | modules: |
| 3 | - meta: |
| 4 | plugin_name: go.d.plugin |
| 5 | module_name: ap |
| 6 | monitored_instance: |
| 7 | name: Access Points |
| 8 | link: "" |
| 9 | categories: |
| 10 | - data-collection.networking |
| 11 | icon_filename: "network-wired.svg" |
| 12 | related_resources: |
| 13 | integrations: |
| 14 | list: [] |
| 15 | info_provided_to_referring_integrations: |
| 16 | description: "" |
| 17 | keywords: |
| 18 | - ap |
| 19 | - access |
| 20 | - point |
| 21 | - wireless |
| 22 | - network |
| 23 | overview: |
| 24 | data_collection: |
| 25 | metrics_description: | |
| 26 | This collector monitors various wireless access point metrics like connected clients, bandwidth, packets, transmit issues, signal strength, and bitrate for each device and its associated SSID. |
| 27 | method_description: > |
| 28 | This tool uses the `iw` command-line utility to discover nearby access points. |
| 29 | It starts by running `iw dev`, which provides information about all wireless interfaces. |
| 30 | Then, for each interface identified as an access point (type AP), the `iw INTERFACE station dump` command is executed to gather relevant metrics. |
| 31 | supported_platforms: |
| 32 | include: [Linux] |
| 33 | exclude: [] |
| 34 | multi_instance: false |
| 35 | additional_permissions: |
| 36 | description: "" |
| 37 | default_behavior: |
| 38 | auto_detection: |
| 39 | description: "The plugin is able to auto-detect any access points on your Linux machine." |
| 40 | limits: |
| 41 | description: "" |
| 42 | performance_impact: |
| 43 | description: "" |
| 44 | setup: |
| 45 | prerequisites: |
| 46 | list: |
| 47 | - title: "`iw` utility." |
| 48 | description: "Make sure the `iw` utility is installed." |
| 49 | configuration: |
| 50 | file: |
| 51 | name: go.d/ap.conf |
| 52 | options: |
| 53 | description: | |
| 54 | The following options can be defined globally: update_every. |
| 55 | folding: |
| 56 | title: Config options |
| 57 | enabled: true |
| 58 | list: |
| 59 | - name: update_every |
| 60 | description: Data collection frequency. |
| 61 | default_value: 10 |
| 62 | required: false |
| 63 | - name: binary_path |
| 64 | description: Path to the `iw` binary. If an absolute path is provided, the collector will use it directly; otherwise, it will search for the binary in directories specified in the PATH environment variable. |
| 65 | default_value: /usr/sbin/iw |
| 66 | required: true |
| 67 | - name: timeout |
| 68 | description: Timeout for executing the binary, specified in seconds. |
| 69 | default_value: 2 |
| 70 | required: false |
| 71 | examples: |
| 72 | folding: |
| 73 | title: "" |
| 74 | enabled: false |
| 75 | list: |
| 76 | - name: Custom binary path |
| 77 | description: The executable is not in the directories specified in the PATH environment variable. |
| 78 | config: | |
| 79 | jobs: |
| 80 | - name: custom_iw |
| 81 | binary_path: /usr/local/sbin/iw |
| 82 | troubleshooting: |
| 83 | problems: |
| 84 | list: [] |
| 85 | alerts: [] |
| 86 | metrics: |
| 87 | folding: |
| 88 | title: Metrics |
| 89 | enabled: false |
| 90 | description: "" |
| 91 | availability: [] |
| 92 | scopes: |
| 93 | - name: wireless device |
| 94 | description: "These metrics refer to the entire monitored application." |
| 95 | labels: |
| 96 | - name: device |
| 97 | description: Wireless interface name |
| 98 | - name: ssid |
| 99 | description: SSID |
| 100 | metrics: |
| 101 | - name: ap.clients |
| 102 | description: Connected clients |
| 103 | unit: "clients" |
| 104 | chart_type: line |
| 105 | dimensions: |
| 106 | - name: clients |
| 107 | - name: ap.net |
| 108 | description: Bandwidth |
| 109 | unit: "kilobits/s" |
| 110 | chart_type: area |
| 111 | dimensions: |
| 112 | - name: received |
| 113 | - name: sent |
| 114 | - name: ap.packets |
| 115 | description: Packets |
| 116 | unit: "packets/s" |
| 117 | chart_type: line |
| 118 | dimensions: |
| 119 | - name: received |
| 120 | - name: sent |
| 121 | - name: ap.issues |
| 122 | description: Transmit Issues |
| 123 | unit: "issues/s" |
| 124 | chart_type: line |
| 125 | dimensions: |
| 126 | - name: retries |
| 127 | - name: failures |
| 128 | - name: ap.signal |
| 129 | description: Average Signal |
| 130 | unit: "dBm" |
| 131 | chart_type: line |
| 132 | dimensions: |
| 133 | - name: average signal |
| 134 | - name: ap.bitrate |
| 135 | description: Bitrate |
| 136 | unit: "Mbps" |
| 137 | chart_type: line |
| 138 | dimensions: |
| 139 | - name: receive |
| 140 | - name: transmit |