Skip to content

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 49 commits into from
May 15, 2025
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
49 commits
Select commit Hold shift + click to select a range
d99ec76
initial scaffolding
NouemanKHAL Mar 31, 2025
c5af059
Documentation first cut
iglendd Mar 31, 2025
9af6898
Update wlan/README.md
iglendd Apr 4, 2025
51d3c9a
Added wlan.receive_rate metric to the specification
iglendd Apr 16, 2025
c0905ae
Merge branch 'noueman/add-wlan-integration-tile' of github.com:DataDo…
iglendd Apr 16, 2025
1c07120
Added dashboard JSON and few other minor improvements
iglendd Apr 23, 2025
43d8214
Added pre-requisite section to the README.md file
iglendd Apr 23, 2025
5e03139
Update tile
iglendd Apr 29, 2025
7fbf86a
Fixed manifest.json
iglendd Apr 29, 2025
db8a77b
Trying to fix failed CI
iglendd Apr 29, 2025
c8a8927
fix metadata.csv
NouemanKHAL Apr 29, 2025
52cccba
fix manifest.json
NouemanKHAL Apr 29, 2025
0e5a74f
regenerate manifest.json as normal integration
NouemanKHAL Apr 29, 2025
36e65e5
remove service_checks entry
NouemanKHAL Apr 29, 2025
50efb23
fix manifest.json json format
NouemanKHAL Apr 29, 2025
003a08a
remove monitors and saved views properties
NouemanKHAL Apr 29, 2025
c27d983
fix extra comma in manifest.json
NouemanKHAL Apr 29, 2025
733b783
ddev validate labeler --sync
NouemanKHAL Apr 29, 2025
b580b4a
fix labeler config
NouemanKHAL Apr 29, 2025
3d65a5d
Added monitor template
iglendd Apr 30, 2025
3f42007
Merge branch 'noueman/add-wlan-integration-tile' of github.com:DataDo…
iglendd Apr 30, 2025
41f0750
Fix JSON syntax issue from previous commit
iglendd Apr 30, 2025
66547ce
Fix monitor JSON
iglendd Apr 30, 2025
dd359de
update monitor title and description
NouemanKHAL May 9, 2025
0d56b39
Add macOS prerequisite
iglendd May 12, 2025
afbd68f
Documentation changes
iglendd May 12, 2025
4f36acc
Update wlan/README.md
iglendd May 14, 2025
4c35947
Update wlan/README.md
iglendd May 14, 2025
156e28b
Merge branch 'master' into noueman/add-wlan-integration-tile
NouemanKHAL May 14, 2025
87f0620
Merge branch 'master' into noueman/add-wlan-integration-tile
NouemanKHAL May 14, 2025
66d1ad5
Update wlan/README.md
iglendd May 14, 2025
cc38267
Update wlan/README.md
iglendd May 14, 2025
3caef01
Update wlan/README.md
iglendd May 14, 2025
109d322
Update wlan/README.md
iglendd May 14, 2025
ee5e8b5
Update wlan/README.md
iglendd May 14, 2025
ccc50c4
Update wlan/README.md
iglendd May 14, 2025
7c9a61c
Update wlan/README.md
iglendd May 14, 2025
747f1fd
Update wlan/README.md
iglendd May 14, 2025
c25d9fb
Update wlan/README.md
iglendd May 14, 2025
87b71e8
Update wlan/README.md
iglendd May 14, 2025
a251e35
Update wlan/README.md
iglendd May 14, 2025
263f851
Update wlan/README.md
iglendd May 14, 2025
d83185b
Update wlan/README.md
iglendd May 14, 2025
f2617db
Update wlan/assets/monitors/wlan_excessive_channel_swap.json
iglendd May 14, 2025
0dff9ff
Update README.md
iglendd May 14, 2025
cc437d6
Apply suggestions from code review
NouemanKHAL May 14, 2025
d5415ac
Fix github missing three-back ticks in suggestion
NouemanKHAL May 14, 2025
80857d5
fix overview widgets grouping + add description
NouemanKHAL May 15, 2025
f30e048
fix image logo link to use druids wlan logo
NouemanKHAL May 15, 2025
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions wlan/CHANGELOG.md
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
55 changes: 55 additions & 0 deletions wlan/README.md
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.

### 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.

### Events

wlan does not include any events.

## 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/
1 change: 1 addition & 0 deletions wlan/assets/dashboards/wlan_overview.json
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
1 change: 1 addition & 0 deletions wlan/assets/service_checks.json
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
[]
41 changes: 41 additions & 0 deletions wlan/images/IMAGES_README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
# Marketplace Media Carousel Guidelines
Copy link
Contributor

Choose a reason for hiding this comment

The 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
```
54 changes: 54 additions & 0 deletions wlan/manifest.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
{

Check failure on line 1 in wlan/manifest.json

View check run for this annotation

datadog-assets / validate-logs

Error in logs

{'tile': {'media': {0: {'image_url': ['String does not match expected pattern.']}, 1: {'image_url': ['String does not match expected pattern.']}, 2: {'image_url': ['String does not match expected pattern.']}}, 'classifier_tags': {0: ['Not a valid choice.'], 4: ['Not a valid choice.'], 5: ['Not a valid choice.'], 6: ['Not a valid choice.'], 7: ['Not a valid choice.']}}}
"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"
}
}
6 changes: 6 additions & 0 deletions wlan/metadata.csv
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,
Loading