[CWS] move documentation generation into a regular task #37602

paulcacheux · 2025-06-03T12:01:01Z

What does this PR do?

This PR brings the CWS documentation generation to regular tasks instead of a ad-hoc scripts folder in the docs. This will allow simpler usage, and to include it in cws-go-generate.

Motivation

Describe how you validated your changes

Possible Drawbacks / Trade-offs

Additional Notes

agent-platform-auto-pr · 2025-06-03T12:38:30Z

Gitlab CI Configuration Changes

Modified Jobs

security_go_generate_check

  security_go_generate_check:
    before_script:
    - mkdir -p $GOPATH/pkg/mod/cache && tar xJf modcache.tar.xz -C $GOPATH/pkg/mod/cache
      || exit 101
    - rm -f modcache.tar.xz
    - mkdir -p $GOPATH/pkg/mod/cache && tar xJf modcache_tools.tar.xz -C $GOPATH/pkg/mod/cache
      || exit 101
    - rm -f modcache_tools.tar.xz
    - pip3 install wheel "git+https://github.com/DataDog/datadog-agent-dev.git@v$(cat
      .dda/version)"
-   - pip3 install -r docs/cloud-workload-security/scripts/requirements-docs.txt
    - dda self dep sync -f legacy-tasks
    - dda inv -- -e install-tools
    image: registry.ddbuild.io/ci/datadog-agent-buildimages/linux-glibc-2-17-x64$CI_IMAGE_LINUX_GLIBC_2_17_X64_SUFFIX:$CI_IMAGE_LINUX_GLIBC_2_17_X64
    needs:
    - go_deps
    - go_tools_deps
    script:
    - dda inv -- -e security-agent.go-generate-check
    stage: source_test
    tags:
    - arch:amd64
    variables:
      KUBERNETES_CPU_REQUEST: 4

Changes Summary

Removed	Modified	Added	Renamed
0	1	0	0

ℹ️ Diff available in the job log.

cit-pr-commenter · 2025-06-03T13:38:48Z

Regression Detector

Regression Detector Results

Metrics dashboard
Target profiles
Run ID: f1307475-23da-4f0d-8c8e-7ccf72098414

Baseline: 96e38c9
Comparison: ecf8168
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	+1.53	[-1.49, +4.54]	1	Logs
➖	tcp_syslog_to_blackhole	ingress throughput	+1.35	[+1.29, +1.40]	1	Logs
➖	uds_dogstatsd_20mb_12k_contexts_20_senders	memory utilization	+0.36	[+0.32, +0.41]	1	Logs
➖	ddot_logs	memory utilization	+0.25	[+0.11, +0.39]	1	Logs
➖	docker_containers_memory	memory utilization	+0.18	[+0.07, +0.28]	1	Logs
➖	ddot_metrics	memory utilization	+0.12	[+0.01, +0.24]	1	Logs
➖	file_to_blackhole_0ms_latency_http2	egress throughput	+0.10	[-0.48, +0.67]	1	Logs
➖	file_to_blackhole_300ms_latency	egress throughput	+0.07	[-0.55, +0.69]	1	Logs
➖	file_to_blackhole_1000ms_latency_linear_load	egress throughput	+0.03	[-0.20, +0.26]	1	Logs
➖	tcp_dd_logs_filter_exclude	ingress throughput	+0.00	[-0.02, +0.03]	1	Logs
➖	uds_dogstatsd_to_api	ingress throughput	-0.01	[-0.28, +0.27]	1	Logs
➖	file_to_blackhole_0ms_latency	egress throughput	-0.01	[-0.57, +0.54]	1	Logs
➖	file_to_blackhole_1000ms_latency	egress throughput	-0.02	[-0.56, +0.52]	1	Logs
➖	file_to_blackhole_0ms_latency_http1	egress throughput	-0.05	[-0.64, +0.55]	1	Logs
➖	file_to_blackhole_500ms_latency	egress throughput	-0.08	[-0.71, +0.55]	1	Logs
➖	file_to_blackhole_100ms_latency	egress throughput	-0.10	[-0.72, +0.51]	1	Logs
➖	otlp_ingest_logs	memory utilization	-0.19	[-0.31, -0.06]	1	Logs
➖	quality_gate_idle	memory utilization	-0.21	[-0.27, -0.16]	1	Logs bounds checks dashboard
➖	otlp_ingest_metrics	memory utilization	-0.36	[-0.52, -0.20]	1	Logs
➖	quality_gate_idle_all_features	memory utilization	-0.48	[-0.56, -0.40]	1	Logs bounds checks dashboard
➖	uds_dogstatsd_to_api_cpu	% cpu utilization	-0.64	[-1.54, +0.26]	1	Logs
➖	file_tree	memory utilization	-1.00	[-1.15, -0.84]	1	Logs
➖	quality_gate_logs	% cpu utilization	-2.65	[-5.38, +0.09]	1	Logs bounds checks dashboard

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:

Its estimated |Δ mean %| ≥ 5.00%, indicating the change is big enough to merit a closer look.
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.
Its configuration does not mark it "erratic".

CI Pass/Fail Decision

✅ Passed. All Quality Gates 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 lost_bytes: 10/10 replicas passed. Gate passed.
quality_gate_logs, 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_all_features, bounds check intake_connections: 10/10 replicas passed. Gate passed.

agent-platform-auto-pr · 2025-06-03T14:18:23Z

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}$$	$${696.06}$$ < $${752.99}$$	$${+0.07}$$	$${176.05}$$ < $${187.44}$$
✅	agent_deb_amd64_fips	$${0}$$	$${694.29}$$ < $${751.36}$$	$${+0}$$	$${175.48}$$ < $${187.06}$$
✅	agent_heroku_amd64	$${0}$$	$${358.56}$$ < $${369.68}$$	$${+0}$$	$${96.5}$$ < $${99.55}$$
✅	agent_msi	$${0}$$	$${959.87}$$ < $${987.01}$$	$${+0.02}$$	$${146.46}$$ < $${150.72}$$
✅	agent_rpm_amd64	$${0}$$	$${696.05}$$ < $${752.98}$$	$${-0.03}$$	$${177.52}$$ < $${190.03}$$
✅	agent_rpm_amd64_fips	$${0}$$	$${694.28}$$ < $${751.35}$$	$${-0.05}$$	$${177.38}$$ < $${189.81}$$
✅	agent_rpm_arm64	$${0}$$	$${686.0}$$ < $${739.42}$$	$${+0.02}$$	$${161.03}$$ < $${171.23}$$
✅	agent_rpm_arm64_fips	$${0}$$	$${684.35}$$ < $${737.91}$$	$${-0.03}$$	$${160.04}$$ < $${170.22}$$
✅	agent_suse_amd64	$${0}$$	$${696.05}$$ < $${752.98}$$	$${-0.03}$$	$${177.52}$$ < $${190.03}$$
✅	agent_suse_amd64_fips	$${0}$$	$${694.28}$$ < $${751.35}$$	$${-0.05}$$	$${177.38}$$ < $${189.81}$$
✅	agent_suse_arm64	$${0}$$	$${686.0}$$ < $${739.42}$$	$${+0.02}$$	$${161.03}$$ < $${171.23}$$
✅	agent_suse_arm64_fips	$${0}$$	$${684.35}$$ < $${737.91}$$	$${-0.03}$$	$${160.04}$$ < $${170.22}$$
✅	docker_agent_amd64	$${+0}$$	$${779.85}$$ < $${849.39}$$	$${-0}$$	$${268.59}$$ < $${288.34}$$
✅	docker_agent_arm64	$${+0}$$	$${793.26}$$ < $${858.97}$$	$${+0}$$	$${255.98}$$ < $${274.36}$$
✅	docker_agent_jmx_amd64	$${+0}$$	$${779.85}$$ < $${849.39}$$	$${-0}$$	$${268.59}$$ < $${288.34}$$
✅	docker_agent_jmx_arm64	$${+0}$$	$${793.26}$$ < $${858.97}$$	$${+0}$$	$${255.98}$$ < $${274.36}$$
✅	docker_agent_windows1809	$${+0}$$	$${779.85}$$ < $${849.39}$$	$${-0}$$	$${268.59}$$ < $${288.34}$$
✅	docker_agent_windows1809_core	$${+0}$$	$${779.85}$$ < $${849.39}$$	$${-0}$$	$${268.59}$$ < $${288.34}$$
✅	docker_agent_windows1809_core_jmx	$${+0}$$	$${779.85}$$ < $${849.39}$$	$${-0}$$	$${268.59}$$ < $${288.34}$$
✅	docker_agent_windows1809_jmx	$${+0}$$	$${779.85}$$ < $${849.39}$$	$${-0}$$	$${268.59}$$ < $${288.34}$$
✅	docker_agent_windows2022	$${+0}$$	$${779.85}$$ < $${849.39}$$	$${-0}$$	$${268.59}$$ < $${288.34}$$
✅	docker_agent_windows2022_core	$${+0}$$	$${779.85}$$ < $${849.39}$$	$${-0}$$	$${268.59}$$ < $${288.34}$$
✅	docker_agent_windows2022_core_jmx	$${+0}$$	$${779.85}$$ < $${849.39}$$	$${-0}$$	$${268.59}$$ < $${288.34}$$
✅	docker_agent_windows2022_jmx	$${+0}$$	$${779.85}$$ < $${849.39}$$	$${-0}$$	$${268.59}$$ < $${288.34}$$
✅	docker_cluster_agent_amd64	$${-0}$$	$${259.2}$$ < $${259.73}$$	$${-0}$$	$${102.88}$$ < $${103.68}$$
✅	docker_cluster_agent_arm64	$${-0}$$	$${273.58}$$ < $${274.24}$$	$${-0}$$	$${97.61}$$ < $${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.14}$$ < $${13.86}$$
✅	iot_agent_deb_armhf	$${0}$$	$${47.52}$$ < $${56.41}$$	$${+0}$$	$${11.22}$$ < $${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}$$

paulcacheux · 2025-06-10T13:39:32Z

/merge

dd-devflow · 2025-06-10T13:39:37Z

View all feedbacks in Devflow UI.

2025-06-10 13:39:37 UTC ℹ️ Start processing command /merge

2025-06-10 13:39:46 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-06-10 14:05:09 UTC ℹ️ MergeQueue: merge request added to the queue

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

2025-06-10 14:45:17 UTC ℹ️ MergeQueue: This merge request was merged

github-actions bot added medium review PR review might take time team/agent-security labels Jun 3, 2025

paulcacheux mentioned this pull request Jun 3, 2025

add jinja2 to the list of dependencies DataDog/datadog-agent-dev#113

Merged

paulcacheux force-pushed the paulcacheux/bring-docs-back-in branch from 07dccd5 to 83f3c78 Compare June 10, 2025 08:52

paulcacheux added qa/no-code-change No code change in Agent code requiring validation changelog/no-changelog labels Jun 10, 2025

paulcacheux changed the title ~~Paulcacheux/bring docs back in~~ [CWS] move documentation generation into a regular task Jun 10, 2025

paulcacheux marked this pull request as ready for review June 10, 2025 11:18

paulcacheux requested review from a team as code owners June 10, 2025 11:18

move script files to tasks

3326856

paulcacheux force-pushed the paulcacheux/bring-docs-back-in branch from 83f3c78 to 6e5376d Compare June 10, 2025 11:37

paulcacheux added 6 commits June 10, 2025 14:00

convert scripts to functions

faa4012

generate documentation from cws go generate

d196d83

move templates as well

9e11281

fix readme

28c17c5

update CODEOWNERS

952db3b

fix CI check

b2197ec

paulcacheux force-pushed the paulcacheux/bring-docs-back-in branch from 6e5376d to b2197ec Compare June 10, 2025 12:00

spikat approved these changes Jun 10, 2025

View reviewed changes

add some noqa to skip vulture checks

ecf8168

paulcacheux force-pushed the paulcacheux/bring-docs-back-in branch from 570c339 to ecf8168 Compare June 10, 2025 12:14

chouetz approved these changes Jun 10, 2025

View reviewed changes

paulcacheux mentioned this pull request Jun 10, 2025

[CWS] remove generate_cws_documentation entry in go_generate_check #37820

Merged

dd-mergequeue bot merged commit 095afc8 into main Jun 10, 2025
324 checks passed

dd-mergequeue bot deleted the paulcacheux/bring-docs-back-in branch June 10, 2025 14:45

github-actions bot added this to the 7.68.0 milestone Jun 10, 2025

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

[CWS] move documentation generation into a regular task #37602

[CWS] move documentation generation into a regular task #37602

Uh oh!

paulcacheux commented Jun 3, 2025 •

edited

Loading

Uh oh!

agent-platform-auto-pr bot commented Jun 3, 2025 •

edited

Loading

Uh oh!

cit-pr-commenter bot commented Jun 3, 2025 •

edited

Loading

Fine details of change detection per experiment

Bounds Checks: ✅ Passed

Explanation

Uh oh!

agent-platform-auto-pr bot commented Jun 3, 2025 •

edited

Loading

Info

Uh oh!

paulcacheux commented Jun 10, 2025

Uh oh!

dd-devflow bot commented Jun 10, 2025 •

edited

Loading

Uh oh!

Uh oh!

Uh oh!

[CWS] move documentation generation into a regular task #37602

[CWS] move documentation generation into a regular task #37602

Uh oh!

Conversation

paulcacheux commented Jun 3, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

What does this PR do?

Motivation

Describe how you validated your changes

Possible Drawbacks / Trade-offs

Additional Notes

Uh oh!

agent-platform-auto-pr bot commented Jun 3, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Gitlab CI Configuration Changes

Modified Jobs

Changes Summary

Uh oh!

cit-pr-commenter bot commented Jun 3, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Regression Detector

Regression Detector Results

Optimization Goals: ✅ No significant changes detected

Fine details of change detection per experiment

Bounds Checks: ✅ Passed

Explanation

CI Pass/Fail Decision

Uh oh!

agent-platform-auto-pr bot commented Jun 3, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Static quality checks

Info

Uh oh!

paulcacheux commented Jun 10, 2025

Uh oh!

dd-devflow bot commented Jun 10, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

paulcacheux commented Jun 3, 2025 •

edited

Loading

agent-platform-auto-pr bot commented Jun 3, 2025 •

edited

Loading

cit-pr-commenter bot commented Jun 3, 2025 •

edited

Loading

agent-platform-auto-pr bot commented Jun 3, 2025 •

edited

Loading

dd-devflow bot commented Jun 10, 2025 •

edited

Loading