[RFC] [ACIX-453] Implement Shared Agent 6 / 7 Tasks

[CelianR]

What does this PR do?

Note

• Documentation.
• Please refer to this RFC.
• Tasks will be migrated to share tasks in future PRs).

This implements this RFC to allow creating shared tasks (tasks that can be executed on a specific branch).

Such a task can be created like this:

@task
def sharedtask(ctx, branch):
	with agent_context(ctx, branch):
		# Shared code to run applying to the specific branch

Changes:

• Implemented context switching
• Added worktree tasks (init worktree context / run a command from this context)
• Refactored DEFAULT_BRANCH to get_default_branch() to get the default branch of the current context. Also refactored code when main was used
• GoModules are not cached anymore (since they can change even though the path is not changed)
• Tested agent context

Motivation

Describe how to test/QA your changes

Tasks

$ inv worktree.run 6.53.x pwd
# ~/dd/datadog-agent-worktree

$ inv worktree.run 6.53.x 'git branch'
# 6.53.x

$ inv worktree.invoke 6.53.x modules.show-all
# Will show less modules than `inv modules.show-all`

Possible Drawbacks / Trade-offs

Additional Notes

[chouetz]

TBD if we want to have the same behaviour (workdir) for agent6 & agent7 or not

[chouetz]

I suppose we should update the release coordinator guide with what we must call in the agent6 context

[chouetz]

Is it only for agent6? Or will/should we create also a worktree for agent7. This is a bit overkill as the tools are still in the datadog-agent repo but it make senses with the potential migration to devtool, wdyt?

[chouetz]

not related to this PR but we might need to adapt this if we want it to work properly for both agent6 & 7: something that could look like

Suggested change

	Pinned to datadog-agent v{agent7_version}: `CHANGELOG <https://github.com/{GITHUB_REPO_NAME}/blob/{get_default_branch()}/CHANGELOG.rst#{agent7_version.replace('.', '')}{agent6_version}>`_."""
	Pinned to datadog-agent v{agent_version}: `CHANGELOG <https://github.com/{GITHUB_REPO_NAME}/blob/{get_default_branch()}/CHANGELOG.rst#{agent_version.replace('.', '')}>`_."""

[cit-pr-commenter]

Regression Detector

Regression Detector Results

Metrics dashboard
Target profiles
Run ID: 4ead2161-7c05-48d1-adb6-855be2577adc

Baseline: c1ac65c
Comparison: 259efe7
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	+1.05	[+0.99, +1.12]	1	Logs
➖	uds_dogstatsd_to_api_cpu	% cpu utilization	+0.14	[-0.59, +0.88]	1	Logs
➖	file_to_blackhole_500ms_latency	egress throughput	+0.09	[-0.69, +0.86]	1	Logs
➖	file_to_blackhole_300ms_latency	egress throughput	+0.03	[-0.59, +0.66]	1	Logs
➖	uds_dogstatsd_to_api	ingress throughput	+0.01	[-0.10, +0.12]	1	Logs
➖	tcp_dd_logs_filter_exclude	ingress throughput	-0.00	[-0.01, +0.01]	1	Logs
➖	file_to_blackhole_1000ms_latency	egress throughput	-0.01	[-0.78, +0.77]	1	Logs
➖	file_to_blackhole_0ms_latency	egress throughput	-0.01	[-0.77, +0.75]	1	Logs
➖	file_to_blackhole_100ms_latency	egress throughput	-0.01	[-0.79, +0.76]	1	Logs
➖	quality_gate_idle_all_features	memory utilization	-0.18	[-0.31, -0.05]	1	Logs bounds checks dashboard
➖	file_to_blackhole_1000ms_latency_linear_load	egress throughput	-0.22	[-0.69, +0.25]	1	Logs
➖	quality_gate_idle	memory utilization	-0.45	[-0.53, -0.38]	1	Logs bounds checks dashboard
➖	otel_to_otel_logs	ingress throughput	-0.94	[-1.63, -0.25]	1	Logs
➖	file_tree	memory utilization	-1.26	[-1.40, -1.12]	1	Logs
➖	pycheck_lots_of_tags	% cpu utilization	-1.88	[-5.39, +1.62]	1	Logs
➖	basic_py_check	% cpu utilization	-4.42	[-8.28, -0.57]	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_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

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 memory_usage: 10/10 replicas passed. Gate passed.
• quality_gate_idle, bounds check memory_usage: 10/10 replicas passed. Gate passed.

[sabrina-datadog]

looks good so far, had some minor suggestions! :)

[sabrina-datadog]

looks good to me! 👍

[chouetz]

Minor comment

[chouetz]

What's the point of initialising the worktree to main by default? Should we make the branch a mandatory argument?

[CelianR]

In some cases, we want to enter the environment without changing the branch. main is used to create the worktree in any case. For example, some release tasks won't have the branch argument required such that we:

1. Switch to the target branch
2. Apply tasks such as tag_modules etc. without specifying again the branch

In the release tasks, it is also possible that a task calls an inner function that will reuse the current context without switching the branch explicitly

[CelianR]

/merge

[dd-devflow]

Devflow running: /merge

View all feedbacks in Devflow UI.

---

2024-11-27 10:30:18 UTC ℹ️ MergeQueue: pull request added to the queue

The median merge time in main is 23m.