diff options
Diffstat (limited to '')
| -rw-r--r-- | src/go/plugin/go.d/modules/ap/metadata.yaml (renamed from src/collectors/charts.d.plugin/ap/metadata.yaml) | 83 |
1 files changed, 39 insertions, 44 deletions
diff --git a/src/collectors/charts.d.plugin/ap/metadata.yaml b/src/go/plugin/go.d/modules/ap/metadata.yaml index 6556b42ec..848684d30 100644 --- a/src/collectors/charts.d.plugin/ap/metadata.yaml +++ b/src/go/plugin/go.d/modules/ap/metadata.yaml @@ -1,7 +1,7 @@ -plugin_name: charts.d.plugin +plugin_name: go.d.plugin modules: - meta: - plugin_name: charts.d.plugin + plugin_name: go.d.plugin module_name: ap monitored_instance: name: Access Points @@ -23,8 +23,12 @@ modules: most_popular: false overview: data_collection: - metrics_description: "The ap collector visualizes data related to wireless access points." - method_description: "It uses the `iw` command line utility to detect access points. For each interface that is of `type AP`, it then runs `iw INTERFACE station dump` and collects statistics." + metrics_description: | + 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. + method_description: > + This tool uses the `iw` command-line utility to discover nearby access points. + It starts by running `iw dev`, which provides information about all wireless interfaces. + Then, for each interface identified as an access point (type AP), the `iw INTERFACE station dump` command is executed to gather relevant metrics. supported_platforms: include: [Linux] exclude: [] @@ -33,7 +37,7 @@ modules: description: "" default_behavior: auto_detection: - description: "The plugin is able to auto-detect if you are running access points on your linux box." + description: "The plugin is able to auto-detect any access points on your Linux machine." limits: description: "" performance_impact: @@ -41,53 +45,41 @@ modules: setup: prerequisites: list: - - title: "Install charts.d plugin" - description: | - If [using our official native DEB/RPM packages](/packaging/installer/UPDATE.md#determine-which-installation-method-you-used), make sure `netdata-plugin-chartsd` is installed. - title: "`iw` utility." description: "Make sure the `iw` utility is installed." configuration: file: - name: charts.d/ap.conf + name: go.d/ap.conf options: description: | - The config file is sourced by the charts.d plugin. It's a standard bash file. - - The following collapsed table contains all the options that can be configured for the ap collector. + The following options can be defined globally: update_every. folding: - title: "Config options" + title: Config options enabled: true list: - - name: ap_update_every - description: The data collection frequency. If unset, will inherit the netdata update frequency. - default_value: 1 - required: false - - name: ap_priority - description: Controls the order of charts at the netdata dashboard. - default_value: 6900 - required: false - - name: ap_retries - description: The number of retries to do in case of failure before disabling the collector. + - name: update_every + description: Data collection frequency. default_value: 10 required: false + - name: binary_path + 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. + default_value: /usr/sbin/iw + required: true + - name: timeout + description: Timeout for executing the binary, specified in seconds. + default_value: 2 + required: false examples: folding: + title: "" enabled: false - title: "Config" list: - - name: Change the collection frequency - description: Specify a custom collection frequence (update_every) for this collector + - name: Custom binary path + description: The executable is not in the directories specified in the PATH environment variable. config: | - # the data collection frequency - # if unset, will inherit the netdata update frequency - ap_update_every=10 - - # the charts priority on the dashboard - #ap_priority=6900 - - # the number of retries to do in case of failure - # before disabling the module - #ap_retries=10 + jobs: + - name: custom_iw + binary_path: /usr/local/sbin/iw troubleshooting: problems: list: [] @@ -101,46 +93,49 @@ modules: scopes: - name: wireless device description: "These metrics refer to the entire monitored application." - labels: [] + labels: + - name: device + description: Wireless interface name + - name: ssid + description: SSID metrics: - name: ap.clients - description: Connected clients to ${ssid} on ${dev} + description: Connected clients unit: "clients" chart_type: line dimensions: - name: clients - name: ap.net - description: Bandwidth for ${ssid} on ${dev} + description: Bandwidth unit: "kilobits/s" chart_type: area dimensions: - name: received - name: sent - name: ap.packets - description: Packets for ${ssid} on ${dev} + description: Packets unit: "packets/s" chart_type: line dimensions: - name: received - name: sent - name: ap.issues - description: Transmit Issues for ${ssid} on ${dev} + description: Transmit Issues unit: "issues/s" chart_type: line dimensions: - name: retries - name: failures - name: ap.signal - description: Average Signal for ${ssid} on ${dev} + description: Average Signal unit: "dBm" chart_type: line dimensions: - name: average signal - name: ap.bitrate - description: Bitrate for ${ssid} on ${dev} + description: Bitrate unit: "Mbps" chart_type: line dimensions: - name: receive - name: transmit - - name: expected |