Skip to content
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

Add WLAN Integration #32530

Open
wants to merge 53 commits into
base: main
Choose a base branch
from
Open

Add WLAN Integration #32530

wants to merge 53 commits into from

Conversation

NouemanKHAL
Copy link
Member

@NouemanKHAL NouemanKHAL commented Dec 27, 2024

What does this PR do?

Adds a WLAN integration as a corecheck in the agent.

Motivation

Monitor the current Wi-Fi interface in use and collect various metrics to check the health of the Wi-Fi connection.
For now, the check collects the following data:

  • RSSI (Received signal strength indicator)
  • Transmit Rate
  • Channel Swap Events
  • Roaming Events
  • ActivePHYMode (to determine wheter the Wi-Fi interface is active or not)

Describe how you validated your changes

  • Unit Tests
  • Manual Testing

Possible Drawbacks / Trade-offs

  • Requires Location Services Access on Mac OS

Additional Notes

Copy link

cit-pr-commenter bot commented Dec 27, 2024

Regression Detector

Regression Detector Results

Metrics dashboard
Target profiles
Run ID: c8098e09-6841-44d0-857b-2192f33002c3

Baseline: d00e512
Comparison: 1cdb17c
Diff

Optimization Goals: ✅ No significant changes detected

Fine details of change detection per experiment

perf experiment goal Δ mean % Δ mean % CI trials links
tcp_syslog_to_blackhole ingress throughput +0.73 [+0.67, +0.78] 1 Logs
uds_dogstatsd_to_api_cpu % cpu utilization +0.70 [+0.02, +1.38] 1 Logs
file_tree memory utilization +0.60 [+0.47, +0.74] 1 Logs
quality_gate_idle memory utilization +0.25 [+0.21, +0.28] 1 Logs bounds checks dashboard
file_to_blackhole_0ms_latency_http1 egress throughput +0.05 [-0.77, +0.87] 1 Logs
file_to_blackhole_0ms_latency egress throughput +0.02 [-0.81, +0.86] 1 Logs
file_to_blackhole_0ms_latency_http2 egress throughput +0.02 [-0.85, +0.89] 1 Logs
tcp_dd_logs_filter_exclude ingress throughput -0.00 [-0.01, +0.01] 1 Logs
file_to_blackhole_300ms_latency egress throughput -0.00 [-0.64, +0.64] 1 Logs
uds_dogstatsd_to_api ingress throughput -0.00 [-0.13, +0.12] 1 Logs
file_to_blackhole_500ms_latency egress throughput -0.01 [-0.79, +0.78] 1 Logs
file_to_blackhole_100ms_latency egress throughput -0.02 [-0.65, +0.61] 1 Logs
file_to_blackhole_1000ms_latency egress throughput -0.15 [-0.94, +0.64] 1 Logs
quality_gate_idle_all_features memory utilization -0.19 [-0.27, -0.10] 1 Logs bounds checks dashboard
file_to_blackhole_1000ms_latency_linear_load egress throughput -0.31 [-0.78, +0.15] 1 Logs
quality_gate_logs % cpu utilization -1.78 [-4.99, +1.43] 1 Logs

Bounds Checks: ✅ Passed

perf experiment bounds_check_name replicates_passed links
file_to_blackhole_0ms_latency lost_bytes 10/10
file_to_blackhole_0ms_latency memory_usage 10/10
file_to_blackhole_0ms_latency_http1 lost_bytes 10/10
file_to_blackhole_0ms_latency_http1 memory_usage 10/10
file_to_blackhole_0ms_latency_http2 lost_bytes 10/10
file_to_blackhole_0ms_latency_http2 memory_usage 10/10
file_to_blackhole_1000ms_latency memory_usage 10/10
file_to_blackhole_1000ms_latency_linear_load memory_usage 10/10
file_to_blackhole_100ms_latency lost_bytes 10/10
file_to_blackhole_100ms_latency memory_usage 10/10
file_to_blackhole_300ms_latency lost_bytes 10/10
file_to_blackhole_300ms_latency memory_usage 10/10
file_to_blackhole_500ms_latency lost_bytes 10/10
file_to_blackhole_500ms_latency memory_usage 10/10
quality_gate_idle memory_usage 10/10 bounds checks dashboard
quality_gate_idle_all_features memory_usage 10/10 bounds checks dashboard
quality_gate_logs lost_bytes 10/10
quality_gate_logs memory_usage 10/10

Explanation

Confidence level: 90.00%
Effect size tolerance: |Δ mean %| ≥ 5.00%

Performance changes are noted in the perf column of each table:

  • ✅ = significantly better comparison variant performance
  • ❌ = significantly worse comparison variant performance
  • ➖ = no significant change in performance

A regression test is an A/B test of target performance in a repeatable rig, where "performance" is measured as "comparison variant minus baseline variant" for an optimization goal (e.g., ingress throughput). Due to intrinsic variability in measuring that goal, we can only estimate its mean value for each experiment; we report uncertainty in that value as a 90.00% confidence interval denoted "Δ mean % CI".

For each experiment, we decide whether a change in performance is a "regression" -- a change worth investigating further -- if all of the following criteria are true:

  1. Its estimated |Δ mean %| ≥ 5.00%, indicating the change is big enough to merit a closer look.

  2. Its 90.00% confidence interval "Δ mean % CI" does not contain zero, indicating that if our statistical model is accurate, there is at least a 90.00% chance there is a difference in performance between baseline and comparison variants.

  3. Its configuration does not mark it "erratic".

CI Pass/Fail Decision

Passed. All Quality Gates passed.

  • quality_gate_logs, bounds check lost_bytes: 10/10 replicas passed. Gate passed.
  • quality_gate_logs, bounds check memory_usage: 10/10 replicas passed. Gate passed.
  • quality_gate_idle_all_features, bounds check memory_usage: 10/10 replicas passed. Gate passed.
  • quality_gate_idle, bounds check memory_usage: 10/10 replicas passed. Gate passed.

@NouemanKHAL
Copy link
Member Author

/trigger-ci --variable RUN_ALL_BUILDS=true --variable RUN_KITCHEN_TESTS=true --variable RUN_E2E_TESTS=on --variable RUN_UNIT_TESTS=on --variable RUN_KMT_TESTS=on

@dd-devflow
Copy link

dd-devflow bot commented Dec 27, 2024

Devflow running: /trigger-ci --variable RUN_ALL_BUILDS=true --varia...

View all feedbacks in Devflow UI.


2024-12-27 10:02:52 UTC ℹ️ Gitlab pipeline started

Started pipeline #51839006

@NouemanKHAL
Copy link
Member Author

/trigger-ci --variable RUN_ALL_BUILDS=true --variable RUN_KITCHEN_TESTS=true --variable RUN_E2E_TESTS=on --variable RUN_UNIT_TESTS=on --variable RUN_KMT_TESTS=on

@dd-devflow
Copy link

dd-devflow bot commented Dec 27, 2024

Devflow running: /trigger-ci --variable RUN_ALL_BUILDS=true --varia...

View all feedbacks in Devflow UI.


2024-12-27 11:23:59 UTC ℹ️ Gitlab pipeline started

Started pipeline #51841105

Copy link

cit-pr-commenter bot commented Dec 27, 2024

Go Package Import Differences

Baseline: d00e512
Comparison: 1cdb17c

binaryosarchchange
agentlinuxamd64
+1, -0
+github.com/DataDog/datadog-agent/pkg/collector/corechecks/net/wlan
agentlinuxarm64
+1, -0
+github.com/DataDog/datadog-agent/pkg/collector/corechecks/net/wlan
agentwindowsamd64
+1, -0
+github.com/DataDog/datadog-agent/pkg/collector/corechecks/net/wlan
agentdarwinamd64
+1, -0
+github.com/DataDog/datadog-agent/pkg/collector/corechecks/net/wlan
agentdarwinarm64
+1, -0
+github.com/DataDog/datadog-agent/pkg/collector/corechecks/net/wlan
iot-agentlinuxamd64
+1, -0
+github.com/DataDog/datadog-agent/pkg/collector/corechecks/net/wlan
iot-agentlinuxarm64
+1, -0
+github.com/DataDog/datadog-agent/pkg/collector/corechecks/net/wlan
heroku-agentlinuxamd64
+1, -0
+github.com/DataDog/datadog-agent/pkg/collector/corechecks/net/wlan
cluster-agentlinuxamd64
+1, -0
+github.com/DataDog/datadog-agent/pkg/collector/corechecks/net/wlan
cluster-agentlinuxarm64
+1, -0
+github.com/DataDog/datadog-agent/pkg/collector/corechecks/net/wlan

@NouemanKHAL
Copy link
Member Author

/trigger-ci --variable RUN_ALL_BUILDS=true --variable RUN_KITCHEN_TESTS=off --variable RUN_E2E_TESTS=off --variable RUN_UNIT_TESTS=off --variable RUN_KMT_TESTS=off

@dd-devflow
Copy link

dd-devflow bot commented Dec 27, 2024

Devflow running: /trigger-ci --variable RUN_ALL_BUILDS=true --varia...

View all feedbacks in Devflow UI.


2024-12-27 12:42:55 UTC ℹ️ Gitlab pipeline started

Started pipeline #51843048

@NouemanKHAL NouemanKHAL added the qa/done QA done before merge and regressions are covered by tests label Dec 31, 2024
@agent-platform-auto-pr
Copy link
Contributor

agent-platform-auto-pr bot commented Dec 31, 2024

Test changes on VM

Use this command from test-infra-definitions to manually test this PR changes on a VM:

inv aws.create-vm --pipeline-id=52544811 --os-family=ubuntu

Note: This applies to commit 1cdb17c

@agent-platform-auto-pr
Copy link
Contributor

agent-platform-auto-pr bot commented Dec 31, 2024

Uncompressed package size comparison

Comparison with ancestor d00e5123ae99ca85563773144d4decb2f38b2b2a

Diff per package
package diff status size ancestor threshold
datadog-agent-amd64-deb 0.03MB ⚠️ 1012.08MB 1012.05MB 0.50MB
datadog-agent-x86_64-rpm 0.03MB ⚠️ 1021.39MB 1021.37MB 0.50MB
datadog-agent-x86_64-suse 0.03MB ⚠️ 1021.39MB 1021.37MB 0.50MB
datadog-heroku-agent-amd64-deb 0.02MB ⚠️ 506.19MB 506.17MB 0.50MB
datadog-iot-agent-amd64-deb 0.02MB ⚠️ 113.84MB 113.82MB 0.50MB
datadog-iot-agent-x86_64-rpm 0.02MB ⚠️ 113.90MB 113.89MB 0.50MB
datadog-iot-agent-x86_64-suse 0.02MB ⚠️ 113.90MB 113.89MB 0.50MB
datadog-iot-agent-aarch64-rpm 0.02MB ⚠️ 109.35MB 109.33MB 0.50MB
datadog-agent-arm64-deb 0.02MB ⚠️ 941.31MB 941.29MB 0.50MB
datadog-iot-agent-arm64-deb 0.02MB ⚠️ 109.28MB 109.26MB 0.50MB
datadog-agent-aarch64-rpm 0.02MB ⚠️ 950.61MB 950.59MB 0.50MB
datadog-dogstatsd-amd64-deb 0.00MB 58.63MB 58.63MB 0.50MB
datadog-dogstatsd-x86_64-rpm 0.00MB 58.71MB 58.71MB 0.50MB
datadog-dogstatsd-x86_64-suse 0.00MB 58.71MB 58.71MB 0.50MB
datadog-dogstatsd-arm64-deb 0.00MB 56.14MB 56.14MB 0.50MB

Decision

⚠️ Warning

@github-actions github-actions bot added long review PR is complex, plan time to review it and removed medium review PR review might take time labels Jan 3, 2025
@NouemanKHAL NouemanKHAL marked this pull request as ready for review January 3, 2025 08:34
@NouemanKHAL NouemanKHAL requested review from a team as code owners January 3, 2025 08:34
@NouemanKHAL NouemanKHAL changed the title [WIP] Add WLAN Integration Add WLAN Integration Jan 3, 2025
info.channel = (int)wifiInterface.wlanChannel.channelNumber;
info.noise = (int)wifiInterface.noiseMeasurement;
info.transmitRate = wifiInterface.transmitRate;
info.hardwareAddress = [[wifiInterface hardwareAddress] UTF8String];
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

hardwareAddress can return nil, would it make sense to check for it?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes! I will check it in the same manner as the SSID and BSSID and replace it with a unknown default value.

WiFiInfo info;

info.rssi = (int)wifiInterface.rssiValue;
info.ssid = [[wifiInterface ssid] UTF8String];
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not very familiar with objective c, is UTF8String value is going to be valid long enough to read with GoString? When the NSString returned by ssid is freed?

Copy link
Member Author

@NouemanKHAL NouemanKHAL Jan 9, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi @vickenty, you're right! The object could be released on the Objective C side possibily via Automatic Reference Counting, so there is a chance that on the Go side we won't have enough time to read the string.

To avoid such cases, I wrapped the whole function body in a @autoreleasepool that will automatically handle memory allocation/deallocation during the function lifetime / scope, and then we will just return a copy the string and manually free it on the Go side.

Reference: Advanced Memory Management Programming Guide by Apple


// Wrapper function to start location updates
void InitLocationServices() {
LocationManager *locationManager = [[LocationManager alloc] init];
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This gets called every check run, is this allocating a new object every time? Will those be released automatically?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The check will probably run every 30-45s, I suggest we sleep for 5-10 seconds the time we retrieve the wifi information and we get the location access, and then release the locationManager object.
What do you think? I don't think that we can persist the code between different check runs.

Copy link
Member

@gh123man gh123man Jan 9, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Since InitLocationServices is always called right before GetWiFiInformation - can we put this inside the autorelease pool (inside GetWiFiInformation)? It looks like these are always called consecutively.

AFAIK right now this code is leaking locationManager on every run.

I guess a followup question is - do we even need to handle the delegate callbacks in location manager? Can we instead just check authorizationStatus, if grants permission - just query wifi state? (I'm not sure CWWiFiClient needs a long lived CLLocationManager - just permissions correct me if I'm wrong)

If authorizationStatus denies permission, call requestWhenInUseAuthorization. And in the next check run, we will hopefully have permission at that point

FWIW authorizationStatus is a class method, so we don't need to init a locationManager if we already have permission on future runs.

}

- (void)locationManager:(CLLocationManager *)manager didFailWithError:(NSError *)error {
NSLog(@"Location update failed with error: %@", error.localizedDescription);
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Where do these messages end up? Would it make sense to use agent logging facilities instead?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It definitely would be better, would it be easy to do that? I guess I could use the C API of the agent? I'm not very familiar with that, any help would be appreciated!

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I see two ways:

  • add logging C logging function in cgo, and call it from Objective C (the agent doesn't have a C API that can be used here)
  • accumulate errors in the obj-c code and extract them as needed in the go check code.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
long review PR is complex, plan time to review it qa/done QA done before merge and regressions are covered by tests team/platform-integrations
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants