Skip to content

[CWS] Introduce scope_field for process scope #37709

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 2 commits into from
Jun 11, 2025
Merged

Conversation

Gui774ume
Copy link
Contributor

What does this PR do?

This PR introduces scope_field for scoped variable in set actions.

Motivation

The goal of this field is to provide which field should be used to query the scope of the variable modified in this action. The goal of this field is to allow updating the value of a variable for a different process than the one that triggered the rule.

Example use case: setting the execution context of the target process of a cgroup_write event.

- id: cgroup_write_execution_context
  expression: cgroup_write.pid > 0
  actions:
    - set:
        name: correlation_key
        expression: '"first_${builtins.uuid4}"'
        scope: process
        scope_field: cgroup_write.pid
        inherited: true

Describe how you validated your changes

Tests were added.

Possible Drawbacks / Trade-offs

Additional Notes

@Gui774ume Gui774ume added this to the 7.68.0 milestone Jun 5, 2025
@Gui774ume Gui774ume requested a review from a team as a code owner June 5, 2025 20:55
@Gui774ume Gui774ume added component/system-probe team/agent-security qa/done QA done before merge and regressions are covered by tests labels Jun 5, 2025
@Gui774ume Gui774ume force-pushed the will/scope-field branch 2 times, most recently from f3564f1 to 09366c9 Compare June 10, 2025 07:42
Base automatically changed from will/export-cgroup-write-event to main June 10, 2025 09:49
@dd-mergequeue dd-mergequeue bot requested a review from a team as a code owner June 10, 2025 09:49
@github-actions github-actions bot added the long review PR is complex, plan time to review it label Jun 10, 2025
Copy link

cit-pr-commenter bot commented Jun 10, 2025

Regression Detector

Regression Detector Results

Metrics dashboard
Target profiles
Run ID: b5e2f297-9eff-4641-ba83-1bb3a25d2275

Baseline: 96e38c9
Comparison: 00d18af
Diff

Optimization Goals: ✅ No significant changes detected

Fine details of change detection per experiment

perf experiment goal Δ mean % Δ mean % CI trials links
docker_containers_cpu % cpu utilization +2.39 [-0.60, +5.38] 1 Logs
quality_gate_logs % cpu utilization +1.60 [-1.19, +4.39] 1 Logs bounds checks dashboard
otlp_ingest_logs memory utilization +0.71 [+0.58, +0.84] 1 Logs
quality_gate_idle_all_features memory utilization +0.38 [+0.29, +0.46] 1 Logs bounds checks dashboard
docker_containers_memory memory utilization +0.28 [+0.21, +0.36] 1 Logs
ddot_logs memory utilization +0.27 [+0.12, +0.41] 1 Logs
quality_gate_idle memory utilization +0.16 [+0.10, +0.23] 1 Logs bounds checks dashboard
file_to_blackhole_300ms_latency egress throughput +0.14 [-0.48, +0.76] 1 Logs
file_to_blackhole_0ms_latency egress throughput +0.12 [-0.50, +0.73] 1 Logs
file_to_blackhole_100ms_latency egress throughput +0.03 [-0.56, +0.62] 1 Logs
tcp_dd_logs_filter_exclude ingress throughput +0.00 [-0.02, +0.02] 1 Logs
uds_dogstatsd_to_api ingress throughput +0.00 [-0.25, +0.25] 1 Logs
file_to_blackhole_1000ms_latency_linear_load egress throughput -0.03 [-0.26, +0.21] 1 Logs
file_to_blackhole_0ms_latency_http1 egress throughput -0.04 [-0.57, +0.49] 1 Logs
file_to_blackhole_1000ms_latency egress throughput -0.04 [-0.62, +0.53] 1 Logs
uds_dogstatsd_to_api_cpu % cpu utilization -0.05 [-0.90, +0.80] 1 Logs
file_to_blackhole_500ms_latency egress throughput -0.06 [-0.66, +0.54] 1 Logs
uds_dogstatsd_20mb_12k_contexts_20_senders memory utilization -0.09 [-0.14, -0.03] 1 Logs
otlp_ingest_metrics memory utilization -0.10 [-0.26, +0.07] 1 Logs
file_to_blackhole_0ms_latency_http2 egress throughput -0.12 [-0.75, +0.50] 1 Logs
ddot_metrics memory utilization -0.22 [-0.34, -0.11] 1 Logs
file_tree memory utilization -0.28 [-0.41, -0.15] 1 Logs
tcp_syslog_to_blackhole ingress throughput -0.54 [-0.60, -0.48] 1 Logs

Bounds Checks: ✅ Passed

perf experiment bounds_check_name replicates_passed links
docker_containers_cpu simple_check_run 10/10
docker_containers_memory memory_usage 10/10
docker_containers_memory simple_check_run 10/10
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 bounds checks dashboard
quality_gate_logs lost_bytes 10/10 bounds checks dashboard
quality_gate_logs memory_usage 10/10 bounds checks dashboard

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, 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_logs, bounds check intake_connections: 10/10 replicas passed. Gate passed.
  • quality_gate_logs, bounds check memory_usage: 10/10 replicas passed. Gate passed.
  • quality_gate_logs, bounds check lost_bytes: 10/10 replicas passed. Gate passed.
  • quality_gate_idle_all_features, bounds check memory_usage: 10/10 replicas passed. Gate passed.
  • quality_gate_idle_all_features, bounds check intake_connections: 10/10 replicas passed. Gate passed.

@Gui774ume Gui774ume force-pushed the will/scope-field branch 2 times, most recently from 4efaec6 to 7785344 Compare June 10, 2025 13:13
@agent-platform-auto-pr
Copy link
Contributor

Static quality checks

✅ Please find below the results from static quality gates
Comparison made with ancestor 96e38c9

Successful checks

Info

Quality gate Delta On disk size (MiB) Delta On wire size (MiB)
agent_deb_amd64 $${+0.01}$$ $${696.07}$$ < $${752.99}$$ $${+0.07}$$ $${176.05}$$ < $${187.44}$$
agent_deb_amd64_fips $${+0.01}$$ $${694.3}$$ < $${751.36}$$ $${+0.01}$$ $${175.49}$$ < $${187.06}$$
agent_heroku_amd64 $${0}$$ $${358.56}$$ < $${369.68}$$ $${+0}$$ $${96.5}$$ < $${99.55}$$
agent_msi $${+0.01}$$ $${959.88}$$ < $${987.01}$$ $${+0.01}$$ $${146.45}$$ < $${150.72}$$
agent_rpm_amd64 $${+0.01}$$ $${696.06}$$ < $${752.98}$$ $${-0}$$ $${177.54}$$ < $${190.03}$$
agent_rpm_amd64_fips $${+0.01}$$ $${694.29}$$ < $${751.35}$$ $${-0.04}$$ $${177.39}$$ < $${189.81}$$
agent_rpm_arm64 $${+0}$$ $${686.01}$$ < $${739.42}$$ $${+0.01}$$ $${161.02}$$ < $${171.23}$$
agent_rpm_arm64_fips $${+0}$$ $${684.36}$$ < $${737.91}$$ $${-0.01}$$ $${160.07}$$ < $${170.22}$$
agent_suse_amd64 $${+0.01}$$ $${696.06}$$ < $${752.98}$$ $${-0}$$ $${177.54}$$ < $${190.03}$$
agent_suse_amd64_fips $${+0.01}$$ $${694.29}$$ < $${751.35}$$ $${-0.04}$$ $${177.39}$$ < $${189.81}$$
agent_suse_arm64 $${+0}$$ $${686.01}$$ < $${739.42}$$ $${+0.01}$$ $${161.02}$$ < $${171.23}$$
agent_suse_arm64_fips $${+0}$$ $${684.36}$$ < $${737.91}$$ $${-0.01}$$ $${160.07}$$ < $${170.22}$$
docker_agent_amd64 $${+0.01}$$ $${779.86}$$ < $${849.39}$$ $${+0.02}$$ $${268.61}$$ < $${288.34}$$
docker_agent_arm64 $${+0}$$ $${793.26}$$ < $${858.97}$$ $${-0}$$ $${255.98}$$ < $${274.36}$$
docker_agent_jmx_amd64 $${+0.01}$$ $${779.86}$$ < $${849.39}$$ $${+0.02}$$ $${268.61}$$ < $${288.34}$$
docker_agent_jmx_arm64 $${+0}$$ $${793.26}$$ < $${858.97}$$ $${-0}$$ $${255.98}$$ < $${274.36}$$
docker_agent_windows1809 $${+0.01}$$ $${779.86}$$ < $${849.39}$$ $${+0.02}$$ $${268.61}$$ < $${288.34}$$
docker_agent_windows1809_core $${+0.01}$$ $${779.86}$$ < $${849.39}$$ $${+0.02}$$ $${268.61}$$ < $${288.34}$$
docker_agent_windows1809_core_jmx $${+0.01}$$ $${779.86}$$ < $${849.39}$$ $${+0.02}$$ $${268.61}$$ < $${288.34}$$
docker_agent_windows1809_jmx $${+0.01}$$ $${779.86}$$ < $${849.39}$$ $${+0.02}$$ $${268.61}$$ < $${288.34}$$
docker_agent_windows2022 $${+0.01}$$ $${779.86}$$ < $${849.39}$$ $${+0.02}$$ $${268.61}$$ < $${288.34}$$
docker_agent_windows2022_core $${+0.01}$$ $${779.86}$$ < $${849.39}$$ $${+0.02}$$ $${268.61}$$ < $${288.34}$$
docker_agent_windows2022_core_jmx $${+0.01}$$ $${779.86}$$ < $${849.39}$$ $${+0.02}$$ $${268.61}$$ < $${288.34}$$
docker_agent_windows2022_jmx $${+0.01}$$ $${779.86}$$ < $${849.39}$$ $${+0.02}$$ $${268.61}$$ < $${288.34}$$
docker_cluster_agent_amd64 $${+0.01}$$ $${259.2}$$ < $${259.73}$$ $${+0.01}$$ $${102.89}$$ < $${103.68}$$
docker_cluster_agent_arm64 $${+0.06}$$ $${273.65}$$ < $${274.24}$$ $${-0.02}$$ $${97.59}$$ < $${98.45}$$
docker_cws_instrumentation_amd64 $${0}$$ $${7.08}$$ < $${7.12}$$ $${+0}$$ $${2.95}$$ < $${3.29}$$
docker_cws_instrumentation_arm64 $${0}$$ $${6.69}$$ < $${6.92}$$ $${+0}$$ $${2.7}$$ < $${3.07}$$
docker_dogstatsd_amd64 $${+0}$$ $${38.93}$$ < $${39.57}$$ $${-0}$$ $${14.95}$$ < $${15.76}$$
docker_dogstatsd_arm64 $${+0}$$ $${37.52}$$ < $${38.2}$$ $${+0}$$ $${13.96}$$ < $${14.83}$$
dogstatsd_deb_amd64 $${0}$$ $${30.61}$$ < $${31.52}$$ $${-0}$$ $${8.03}$$ < $${8.97}$$
dogstatsd_deb_arm64 $${0}$$ $${29.16}$$ < $${30.08}$$ $${+0}$$ $${6.97}$$ < $${7.92}$$
dogstatsd_rpm_amd64 $${0}$$ $${30.61}$$ < $${31.52}$$ $${-0}$$ $${8.04}$$ < $${8.98}$$
dogstatsd_suse_amd64 $${0}$$ $${30.61}$$ < $${31.52}$$ $${-0}$$ $${8.04}$$ < $${8.98}$$
iot_agent_deb_amd64 $${0}$$ $${50.49}$$ < $${60.17}$$ $${-0}$$ $${12.85}$$ < $${15.82}$$
iot_agent_deb_arm64 $${0}$$ $${47.94}$$ < $${56.94}$$ $${+0}$$ $${11.15}$$ < $${13.86}$$
iot_agent_deb_armhf $${0}$$ $${47.52}$$ < $${56.41}$$ $${-0.01}$$ $${11.2}$$ < $${13.86}$$
iot_agent_rpm_amd64 $${0}$$ $${50.49}$$ < $${60.18}$$ $${+0}$$ $${12.87}$$ < $${15.84}$$
iot_agent_rpm_arm64 $${0}$$ $${47.94}$$ < $${56.94}$$ $${-0}$$ $${11.16}$$ < $${13.76}$$
iot_agent_suse_amd64 $${0}$$ $${50.49}$$ < $${60.18}$$ $${+0}$$ $${12.87}$$ < $${15.84}$$

@Gui774ume
Copy link
Contributor Author

/merge

@dd-devflow
Copy link

dd-devflow bot commented Jun 11, 2025

View all feedbacks in Devflow UI.

2025-06-11 08:37:20 UTC ℹ️ Start processing command /merge


2025-06-11 08:37:25 UTC ℹ️ MergeQueue: pull request added to the queue

The expected merge time in main is approximately 47m (p90).


2025-06-11 09:15:21 UTC ℹ️ MergeQueue: This merge request was merged

@dd-mergequeue dd-mergequeue bot merged commit a0635df into main Jun 11, 2025
290 checks passed
@dd-mergequeue dd-mergequeue bot deleted the will/scope-field branch June 11, 2025 09:15
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.

4 participants