-
Notifications
You must be signed in to change notification settings - Fork 1.5k
Add WLAN integration tile #19965
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Add WLAN integration tile #19965
Changes from 2 commits
Commits
Show all changes
49 commits
Select commit
Hold shift + click to select a range
d99ec76
initial scaffolding
NouemanKHAL c5af059
Documentation first cut
iglendd 9af6898
Update wlan/README.md
iglendd 51d3c9a
Added wlan.receive_rate metric to the specification
iglendd c0905ae
Merge branch 'noueman/add-wlan-integration-tile' of github.com:DataDo…
iglendd 1c07120
Added dashboard JSON and few other minor improvements
iglendd 43d8214
Added pre-requisite section to the README.md file
iglendd 5e03139
Update tile
iglendd 7fbf86a
Fixed manifest.json
iglendd db8a77b
Trying to fix failed CI
iglendd c8a8927
fix metadata.csv
NouemanKHAL 52cccba
fix manifest.json
NouemanKHAL 0e5a74f
regenerate manifest.json as normal integration
NouemanKHAL 36e65e5
remove service_checks entry
NouemanKHAL 50efb23
fix manifest.json json format
NouemanKHAL 003a08a
remove monitors and saved views properties
NouemanKHAL c27d983
fix extra comma in manifest.json
NouemanKHAL 733b783
ddev validate labeler --sync
NouemanKHAL b580b4a
fix labeler config
NouemanKHAL 3d65a5d
Added monitor template
iglendd 3f42007
Merge branch 'noueman/add-wlan-integration-tile' of github.com:DataDo…
iglendd 41f0750
Fix JSON syntax issue from previous commit
iglendd 66547ce
Fix monitor JSON
iglendd dd359de
update monitor title and description
NouemanKHAL 0d56b39
Add macOS prerequisite
iglendd afbd68f
Documentation changes
iglendd 4f36acc
Update wlan/README.md
iglendd 4c35947
Update wlan/README.md
iglendd 156e28b
Merge branch 'master' into noueman/add-wlan-integration-tile
NouemanKHAL 87f0620
Merge branch 'master' into noueman/add-wlan-integration-tile
NouemanKHAL 66d1ad5
Update wlan/README.md
iglendd cc38267
Update wlan/README.md
iglendd 3caef01
Update wlan/README.md
iglendd 109d322
Update wlan/README.md
iglendd ee5e8b5
Update wlan/README.md
iglendd ccc50c4
Update wlan/README.md
iglendd 7c9a61c
Update wlan/README.md
iglendd 747f1fd
Update wlan/README.md
iglendd c25d9fb
Update wlan/README.md
iglendd 87b71e8
Update wlan/README.md
iglendd a251e35
Update wlan/README.md
iglendd 263f851
Update wlan/README.md
iglendd d83185b
Update wlan/README.md
iglendd f2617db
Update wlan/assets/monitors/wlan_excessive_channel_swap.json
iglendd 0dff9ff
Update README.md
iglendd cc437d6
Apply suggestions from code review
NouemanKHAL d5415ac
Fix github missing three-back ticks in suggestion
NouemanKHAL 80857d5
fix overview widgets grouping + add description
NouemanKHAL f30e048
fix image logo link to use druids wlan logo
NouemanKHAL File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
# CHANGELOG - wlan | ||
|
||
## 1.0.0 / 2025-03-31 | ||
|
||
***Added***: | ||
|
||
* Initial Release |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,55 @@ | ||
# Agent Check: wlan | ||
|
||
## Overview | ||
|
||
This check monitors Wireless LAN (WLAN) networks based on the [IEEE 802.11][1] standards, commonly referred to as Wi-Fi. | ||
|
||
It collects key Wi-Fi metrics, including Access Point (AP) information such as [SSID][2] and [BSSID][3] (as tags), signal quality telemetry like [RSSI][4] and [Noise][5], transmission rate, and transitions count (e.g., [Roaming][6] and [Swapping][7]between APs). These metrics help proactively identify overall wireless network issues, such as overloaded access points, as well as retrospective troubleshooting of poor network performance on individual hosts. | ||
|
||
## Setup | ||
|
||
### Installation | ||
|
||
The wlan check is included in the [Datadog Agent][8], but is not configured. Please see the next section to configure the check. | ||
iglendd marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
### Configuration | ||
|
||
The configuration is located in the `wlan.d/conf.yaml` file in the `conf.d/` folder at the root of your [Agent's configuration directory][9]. See the [sample wlan.d/conf.yaml][10] for all available configuration options. When you are done editing the configuration file, [restart the Agent][11] to load the new configuration. | ||
|
||
#### Tags | ||
|
||
The check automatically tags emitted metrics with SSID, BSSID, MAC Address, Wi-Fi type (A, B, G, N, AC), Wi-Fi Authentication (Open, WEP, WPA, WPA2, WPA3). As noted in [Getting Started with Tags][12] uppercase characers in tag values are replaced by lowercase characters and special characters are replaced with underscores. | ||
|
||
### Validation | ||
|
||
[Run the Agent's status subcommand][13] and look for `wlan` under the **Checks** section. | ||
|
||
## Data Collected | ||
|
||
### Metrics | ||
|
||
See [metadata.csv][14] for a list of metrics provided by this integration. | ||
iglendd marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
### Events | ||
|
||
wlan does not include any events. | ||
iglendd marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
## Troubleshooting | ||
|
||
Need help? Contact [Datadog support][15]. | ||
|
||
[1]: https://en.wikipedia.org/wiki/IEEE_802.11 | ||
[2]: https://en.wikipedia.org/wiki/Service_set_(802.11_network)#SSID | ||
[3]: https://en.wikipedia.org/wiki/Service_set_(802.11_network) | ||
[4]: https://en.wikipedia.org/wiki/Received_signal_strength_indicator | ||
[5]: https://documentation.meraki.com/MR/Wi-Fi_Basics_and_Best_Practices/Signal-to-Noise_Ratio_(SNR)_and_Wireless_Signal_Strength | ||
[6]: https://www.netally.com/tech-tips/what-is-wifi-roaming/ | ||
[7]: https://superuser.com/questions/122441/how-can-i-get-the-same-ssid-for-multiple-access-points | ||
[8]: https://app.datadoghq.com/account/settings/agent/latest | ||
[9]: https://docs.datadoghq.com/agent/guide/agent-configuration-files/ | ||
[10]: https://github.com/DataDog/datadog-agent/blob/main/poc/cmd/agent/dist/conf.d/wlan.d/conf.yaml.example | ||
[11]: https://docs.datadoghq.com/agent/guide/agent-commands/#start-stop-and-restart-the-agent | ||
[12]: https://docs.datadoghq.com/getting_started/tagging/ | ||
[13]: https://docs.datadoghq.com/agent/guide/agent-commands/#agent-status-and-information | ||
[14]: https://github.com/DataDog/integrations-core/blob/master/wlan/metadata.csv | ||
[15]: https://docs.datadoghq.com/help/ |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
Please build an out-of-the-box dashboard for your integration following our best practices here: https://datadoghq.dev/integrations-core/guidelines/dashboards/#best-practices |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
[] |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,41 @@ | ||
# Marketplace Media Carousel Guidelines | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I don't think we need this file/directory |
||
|
||
## Using the media gallery | ||
|
||
Please upload images to use the media gallery. Integrations require a minimum of 3 images. Images should highlight your product, your integration, and a full image of the Datadog integration dashboard. The gallery | ||
can hold a maximum of 8 pieces of media total, and one of these pieces of media | ||
can be a video (guidelines and submission steps below). Images should be | ||
added to your /images directory and referenced in the manifest.json file. | ||
|
||
|
||
## Image and video requirements | ||
|
||
### Images | ||
|
||
``` | ||
File type : .jpg or .png | ||
File size : ~500 KB per image, with a max of 1 MB per image | ||
File dimensions : The image must be between 1440px and 2880px width, with a 16:9 aspect ratio (for example: 1440x810) | ||
File name : Use only letters, numbers, underscores, and hyphens | ||
Color mode : RGB | ||
Color profile : sRGB | ||
Description : 300 characters maximum | ||
``` | ||
|
||
### Video | ||
|
||
To display a video in your media gallery, please send our team the zipped file | ||
or a link to download the video at `marketplace@datadog.com`. In addition, | ||
please upload a thumbnail image for your video as a part of the pull request. | ||
Once approved, we will upload the file to Vimeo and provide you with the | ||
vimeo_id to add to your manifest.json file. Please note that the gallery can | ||
only hold one video. | ||
|
||
``` | ||
File type : MP4 H.264 | ||
File size : Max 1 video; 1 GB maximum size | ||
File dimensions : The aspect ratio must be exactly 16:9, and the resolution must be 1920x1080 or higher | ||
File name : partnerName-appName.mp4 | ||
Run time : Recommendation of 60 seconds or less | ||
Description : 300 characters maximum | ||
``` |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,54 @@ | ||
{ | ||
Check failure on line 1 in wlan/manifest.json
|
||
"manifest_version": "2.0.0", | ||
"app_uuid": "485aa1de-7cfd-44a2-b3f8-cbbcc4c0fb2c", | ||
"app_id": "wlan", | ||
"display_on_public_website": true, | ||
"tile": { | ||
"overview": "README.md#Overview", | ||
"configuration": "README.md#Setup", | ||
"support": "README.md#Support", | ||
"changelog": "CHANGELOG.md", | ||
"description": "<FILL IN - A brief description of what this offering provides>", | ||
"title": "wlan", | ||
"media": [ | ||
{ | ||
"media_type": "image", | ||
"caption": "FILL IN Image 1 caption", | ||
"image_url": "<FILL IN>" | ||
}, | ||
{ | ||
"media_type": "image", | ||
"caption": "FILL IN Image 2 caption", | ||
"image_url": "<FILL IN>" | ||
}, | ||
{ | ||
"media_type": "image", | ||
"caption": "FILL IN Image 3 caption", | ||
"image_url": "<FILL IN>" | ||
} | ||
], | ||
"classifier_tags": [ | ||
"<Add relevant tags from this list: https://docs.datadoghq.com/developers/integrations/check_references/#classifier-tags>", | ||
"Supported OS::Linux", | ||
"Supported OS::Windows", | ||
"Supported OS::macOS", | ||
"Category::<FILL IN>", | ||
"Offering::<FILL IN>", | ||
"Queried Data Type::<FILL IN>", | ||
"Submitted Data Type::<FILL IN>" | ||
] | ||
}, | ||
"assets": { | ||
"dashboards": { | ||
"<FILL IN dashboard short_name ex: integration name overview>": "assets/dashboards/<FILL IN>.json" | ||
}, | ||
"monitors": {}, | ||
"saved_views": {} | ||
}, | ||
"author": { | ||
"support_email": "help@datadoghq.com", | ||
"name": "Datadog", | ||
"homepage": "https://www.datadoghq.com", | ||
"sales_email": "info@datadoghq.com" | ||
} | ||
} |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
metric_name,metric_type,interval,unit_name,per_unit_name,description,orientation,integration,short_name,curated_metric | ||
wlan.rssi,gauge,,dB,,The received signal strength indication (RSSI) measurement (dBm) for the interface,0,wlan,wlan_signal_strength, | ||
wlan.noise,gauge,,dBm,,The noise measurement (dBm) for the interface,0,wlan,wlan_signal_noise, | ||
wlan.transmit_rate,gauge,,Mbps,,The transmit rate (Mbps) for the interface,0,wlan,wlan_tx_rate, | ||
wlan.channel_swap_events,counter,,,The number of times the Wi-Fi channel used by the device changes,0,wlan,wlan_channel_swap_events, | ||
wlan.roaming_events,counter,,,The number of times a device switched between different access points within the same network,0,wlan,wlan_roaming_events, | ||
iglendd marked this conversation as resolved.
Show resolved
Hide resolved
|
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.