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

[CWS] sysctl_snapshot event #34599

Merged
merged 2 commits into from
Mar 5, 2025
Merged

[CWS] sysctl_snapshot event #34599

merged 2 commits into from
Mar 5, 2025

Conversation

Gui774ume
Copy link
Contributor

@Gui774ume Gui774ume commented Feb 28, 2025

What does this PR do?

This PR introduces the sysctl_snapshot event which snapshots periodically the system control parameters in /proc/sys (and the few security relevant ones in /sys/kernel/security) and send the output to Datadog.

2 new parameters were added in order to control this periodical snapshot:

  • runtime_security_config.sysctl.enabled: controls if the system control sysctl event should be manually disabled.
  • runtime_security_config.sysctl.snapshot.enabled: controls if the system control parameter periodical snapshot should be activated.
  • runtime_security_config.sysctl.snapshot.period: controls the period at which the sysctl_snapshot events should be sent.
  • runtime_security_config.sysctl.snapshot.ignored_base_names: defines a list of system control names that should be scrubbed and not sent to Datadog.

Motivation

This PR introduces the sysctl_snapshot event which completes the requirements for tracking sysctl parameters (along with the sysctl event type introduced in #34482).

Describe how you validated your changes

Enable the feature with the configuration parameter, reduce the period and start the agent.
Wait for the configured duration.
You should see a sysctl_snapshot event sent to Datadog.

@Gui774ume Gui774ume added changelog/no-changelog component/system-probe team/agent-security qa/done QA done before merge and regressions are covered by tests labels Feb 28, 2025
@Gui774ume Gui774ume added this to the 7.65.0 milestone Feb 28, 2025
@Gui774ume Gui774ume requested review from a team as code owners February 28, 2025 21:56
@Gui774ume Gui774ume force-pushed the will/sysctl-snapshot-event branch from c8b822e to d1415b8 Compare February 28, 2025 21:57
Copy link

cit-pr-commenter bot commented Feb 28, 2025

Go Package Import Differences

Baseline: 71deb82
Comparison: b49114c

binaryosarchchange
system-probelinuxamd64
+1, -0
+github.com/DataDog/datadog-agent/pkg/security/probe/sysctl
system-probelinuxarm64
+1, -0
+github.com/DataDog/datadog-agent/pkg/security/probe/sysctl

@Gui774ume Gui774ume force-pushed the will/sysctl-snapshot-event branch from d1415b8 to 9697e68 Compare February 28, 2025 22:06
@agent-platform-auto-pr
Copy link
Contributor

agent-platform-auto-pr bot commented Feb 28, 2025

Uncompressed package size comparison

Comparison with ancestor 71deb828c64e5ac29a25bfb73b83c71cba25e1eb

Diff per package
package diff status size ancestor threshold
datadog-agent-amd64-deb 0.02MB ⚠️ 815.45MB 815.44MB 0.50MB
datadog-agent-x86_64-rpm 0.02MB ⚠️ 825.25MB 825.23MB 0.50MB
datadog-agent-x86_64-suse 0.02MB ⚠️ 825.25MB 825.23MB 0.50MB
datadog-agent-aarch64-rpm 0.02MB ⚠️ 816.17MB 816.15MB 0.50MB
datadog-agent-arm64-deb 0.02MB ⚠️ 806.39MB 806.38MB 0.50MB
datadog-dogstatsd-amd64-deb 0.00MB 39.44MB 39.44MB 0.50MB
datadog-dogstatsd-x86_64-rpm 0.00MB 39.51MB 39.51MB 0.50MB
datadog-dogstatsd-x86_64-suse 0.00MB 39.51MB 39.51MB 0.50MB
datadog-dogstatsd-arm64-deb 0.00MB 37.97MB 37.97MB 0.50MB
datadog-heroku-agent-amd64-deb 0.00MB 440.81MB 440.81MB 0.50MB
datadog-iot-agent-amd64-deb 0.00MB 62.14MB 62.14MB 0.50MB
datadog-iot-agent-x86_64-rpm 0.00MB 62.21MB 62.21MB 0.50MB
datadog-iot-agent-x86_64-suse 0.00MB 62.21MB 62.21MB 0.50MB
datadog-iot-agent-arm64-deb 0.00MB 59.37MB 59.37MB 0.50MB
datadog-iot-agent-aarch64-rpm 0.00MB 59.44MB 59.44MB 0.50MB

Decision

⚠️ Warning

Copy link

cit-pr-commenter bot commented Feb 28, 2025

Regression Detector

Regression Detector Results

Metrics dashboard
Target profiles
Run ID: 11b7e515-2b8d-489a-81c9-0ee5b9681b6c

Baseline: 71deb82
Comparison: b49114c
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.79 [+0.74, +0.85] 1 Logs
file_to_blackhole_1000ms_latency egress throughput +0.05 [-0.73, +0.83] 1 Logs
file_tree memory utilization +0.05 [-0.01, +0.11] 1 Logs
file_to_blackhole_0ms_latency_http1 egress throughput +0.05 [-0.80, +0.90] 1 Logs
uds_dogstatsd_to_api ingress throughput +0.01 [-0.26, +0.28] 1 Logs
file_to_blackhole_100ms_latency egress throughput +0.01 [-0.66, +0.67] 1 Logs
file_to_blackhole_0ms_latency egress throughput +0.00 [-0.78, +0.79] 1 Logs
tcp_dd_logs_filter_exclude ingress throughput -0.01 [-0.03, +0.01] 1 Logs
file_to_blackhole_0ms_latency_http2 egress throughput -0.01 [-0.80, +0.77] 1 Logs
quality_gate_idle_all_features memory utilization -0.02 [-0.04, +0.01] 1 Logs bounds checks dashboard
file_to_blackhole_300ms_latency egress throughput -0.02 [-0.65, +0.61] 1 Logs
quality_gate_idle memory utilization -0.03 [-0.07, +0.00] 1 Logs bounds checks dashboard
file_to_blackhole_500ms_latency egress throughput -0.07 [-0.84, +0.70] 1 Logs
file_to_blackhole_1000ms_latency_linear_load egress throughput -0.08 [-0.54, +0.39] 1 Logs
quality_gate_logs % cpu utilization -0.39 [-3.28, +2.51] 1 Logs
uds_dogstatsd_to_api_cpu % cpu utilization -0.62 [-1.51, +0.28] 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 intake_connections 10/10 bounds checks dashboard
quality_gate_idle memory_usage 10/10 bounds checks dashboard
quality_gate_idle_all_features intake_connections 10/10 bounds checks dashboard
quality_gate_idle_all_features memory_usage 10/10 bounds checks dashboard
quality_gate_logs intake_connections 10/10
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_idle_all_features, bounds check intake_connections: 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 intake_connections: 10/10 replicas passed. Gate passed.
  • quality_gate_idle, bounds check memory_usage: 10/10 replicas passed. Gate passed.
  • quality_gate_logs, bounds check memory_usage: 10/10 replicas passed. Gate passed.
  • quality_gate_logs, bounds check intake_connections: 10/10 replicas passed. Gate passed.
  • quality_gate_logs, bounds check lost_bytes: 10/10 replicas passed. Gate passed.

@Gui774ume Gui774ume force-pushed the will/sysctl-snapshot-event branch 3 times, most recently from 73c4cd6 to f61b324 Compare March 3, 2025 08:09
@agent-platform-auto-pr
Copy link
Contributor

agent-platform-auto-pr bot commented Mar 3, 2025

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=57753366 --os-family=ubuntu

Note: This applies to commit b49114c

@agent-platform-auto-pr
Copy link
Contributor

agent-platform-auto-pr bot commented Mar 3, 2025

Static quality checks ✅

Please find below the results from static quality gates

Successful checks

Info

Result Quality gate On disk size On disk size limit On wire size On wire size limit
static_quality_gate_agent_deb_amd64 789.1MiB 801.8MiB 192.33MiB 202.62MiB
static_quality_gate_agent_deb_arm64 780.52MiB 793.14MiB 174.66MiB 184.51MiB
static_quality_gate_agent_rpm_amd64 789.19MiB 801.79MiB 194.4MiB 205.03MiB
static_quality_gate_agent_rpm_arm64 780.42MiB 793.09MiB 175.81MiB 186.44MiB
static_quality_gate_agent_suse_amd64 789.11MiB 801.81MiB 194.4MiB 205.03MiB
static_quality_gate_agent_suse_arm64 780.5MiB 793.14MiB 175.81MiB 186.44MiB
static_quality_gate_dogstatsd_deb_amd64 37.68MiB 47.67MiB 9.78MiB 19.78MiB
static_quality_gate_dogstatsd_deb_arm64 36.29MiB 46.27MiB 8.49MiB 18.49MiB
static_quality_gate_dogstatsd_rpm_amd64 37.68MiB 47.67MiB 9.79MiB 19.79MiB
static_quality_gate_dogstatsd_suse_amd64 37.68MiB 47.67MiB 9.79MiB 19.79MiB
static_quality_gate_iot_agent_deb_amd64 59.34MiB 69.0MiB 14.91MiB 24.8MiB
static_quality_gate_iot_agent_deb_arm64 56.7MiB 66.4MiB 12.88MiB 22.8MiB
static_quality_gate_iot_agent_rpm_amd64 59.34MiB 69.0MiB 14.93MiB 24.8MiB
static_quality_gate_iot_agent_rpm_arm64 56.7MiB 66.4MiB 12.87MiB 22.8MiB
static_quality_gate_iot_agent_suse_amd64 59.34MiB 69.0MiB 14.93MiB 24.8MiB
static_quality_gate_docker_agent_amd64 873.83MiB 886.12MiB 293.99MiB 304.21MiB
static_quality_gate_docker_agent_arm64 888.45MiB 900.79MiB 280.23MiB 290.47MiB
static_quality_gate_docker_agent_jmx_amd64 1.05GiB 1.06GiB 369.1MiB 379.33MiB
static_quality_gate_docker_agent_jmx_arm64 1.05GiB 1.06GiB 351.32MiB 361.55MiB
static_quality_gate_docker_dogstatsd_amd64 45.83MiB 55.78MiB 17.29MiB 27.28MiB
static_quality_gate_docker_dogstatsd_arm64 44.47MiB 54.45MiB 16.16MiB 26.16MiB
static_quality_gate_docker_cluster_agent_amd64 265.03MiB 274.78MiB 106.38MiB 116.28MiB
static_quality_gate_docker_cluster_agent_arm64 280.99MiB 290.82MiB 101.22MiB 111.12MiB

@Gui774ume Gui774ume force-pushed the will/sysctl-event branch from baf55a5 to 95d38d8 Compare March 3, 2025 09:24
@Gui774ume Gui774ume force-pushed the will/sysctl-snapshot-event branch from f61b324 to ef84786 Compare March 3, 2025 09:24
@github-actions github-actions bot added the long review PR is complex, plan time to review it label Mar 3, 2025
@Gui774ume Gui774ume requested a review from a team as a code owner March 3, 2025 12:54
@Gui774ume Gui774ume force-pushed the will/sysctl-snapshot-event branch from e6f8856 to 9fee0f0 Compare March 3, 2025 12:56
Copy link
Contributor

@rahulkaukuntla rahulkaukuntla left a comment

Choose a reason for hiding this comment

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

looks good from agent configuration

@Gui774ume Gui774ume force-pushed the will/sysctl-snapshot-event branch from 9fee0f0 to e8fd6c8 Compare March 4, 2025 15:55
@Gui774ume Gui774ume force-pushed the will/sysctl-event branch from 95d38d8 to 811d364 Compare March 4, 2025 16:02
@Gui774ume Gui774ume force-pushed the will/sysctl-snapshot-event branch 3 times, most recently from a29b0cd to 6e59bcf Compare March 4, 2025 16:27
Base automatically changed from will/sysctl-event to main March 4, 2025 17:43
@Gui774ume Gui774ume force-pushed the will/sysctl-snapshot-event branch from 6e59bcf to b49114c Compare March 5, 2025 08:44
@Gui774ume
Copy link
Contributor Author

/merge

@dd-devflow
Copy link

dd-devflow bot commented Mar 5, 2025

View all feedbacks in Devflow UI.
2025-03-05 08:45:03 UTC ℹ️ Start processing command /merge


2025-03-05 08:45:10 UTC ℹ️ MergeQueue: waiting for PR to be ready

This merge request is not mergeable yet, because of pending checks/missing approvals. It will be added to the queue as soon as checks pass and/or get approvals.
Note: if you pushed new commits since the last approval, you may need additional approval.
You can remove it from the waiting list with /remove command.


2025-03-05 09:33:06 UTC ℹ️ MergeQueue: merge request added to the queue

The median merge time in main is 30m.


2025-03-05 10:14:25 UTC ℹ️ MergeQueue: This merge request was merged

@dd-mergequeue dd-mergequeue bot merged commit 1f25cd9 into main Mar 5, 2025
308 of 325 checks passed
@dd-mergequeue dd-mergequeue bot deleted the will/sysctl-snapshot-event branch March 5, 2025 10:14
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
changelog/no-changelog component/system-probe long review PR is complex, plan time to review it qa/done QA done before merge and regressions are covered by tests team/agent-security
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants