Skip to content

Update devcontainer #37261

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

Draft
wants to merge 2 commits into
base: main
Choose a base branch
from
Draft

Update devcontainer #37261

wants to merge 2 commits into from

Conversation

ofek
Copy link
Contributor

@ofek ofek commented May 22, 2025

What does this PR do?

Motivation

Consolidate developer images to only one per platform

Describe how you validated your changes

Example run: https://github.com/DataDog/datadog-agent/actions/runs/15308606394

And locally:

devcontainer up --workspace-folder .

@ofek ofek requested review from a team as code owners May 22, 2025 05:28
@ofek ofek added changelog/no-changelog qa/no-code-change No code change in Agent code requiring validation team/container-platform The Container Platform Team labels May 22, 2025
@github-actions github-actions bot added the short review PR is simple enough to be reviewed quickly label May 22, 2025
devcontainer["mounts"] = [
"source=/var/run/docker.sock,target=/var/run/docker.sock,type=bind,consistency=cached",
"source=${localEnv:HOME}/.ssh,target=/home/vscode/.ssh,type=bind,consistency=cached",
"source=${localEnv:HOME}${localEnv:USERPROFILE}/.ssh,target=/home/vscode/.ssh,type=bind,consistency=cached",
Copy link
Contributor Author

Choose a reason for hiding this comment

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

@agent-platform-auto-pr
Copy link
Contributor

Uncompressed package size comparison

Comparison with ancestor 8320116218bbf4e877533ed6bb74bc67e6eca8fa

Diff per package
package diff status size ancestor threshold
datadog-agent-amd64-deb 0.00MB 773.34MB 773.34MB 0.50MB
datadog-agent-x86_64-rpm 0.00MB 782.29MB 782.29MB 0.50MB
datadog-agent-x86_64-suse 0.00MB 782.29MB 782.29MB 0.50MB
datadog-agent-arm64-deb 0.00MB 759.29MB 759.29MB 0.50MB
datadog-agent-aarch64-rpm 0.00MB 768.22MB 768.22MB 0.50MB
datadog-dogstatsd-amd64-deb 0.00MB 31.99MB 31.99MB 0.50MB
datadog-dogstatsd-x86_64-rpm 0.00MB 32.07MB 32.07MB 0.50MB
datadog-dogstatsd-x86_64-suse 0.00MB 32.07MB 32.07MB 0.50MB
datadog-dogstatsd-arm64-deb 0.00MB 30.47MB 30.47MB 0.50MB
datadog-heroku-agent-amd64-deb 0.00MB 380.14MB 380.14MB 0.50MB
datadog-iot-agent-amd64-deb 0.00MB 62.70MB 62.70MB 0.50MB
datadog-iot-agent-x86_64-rpm 0.00MB 62.78MB 62.78MB 0.50MB
datadog-iot-agent-x86_64-suse 0.00MB 62.78MB 62.78MB 0.50MB
datadog-iot-agent-arm64-deb 0.00MB 59.27MB 59.27MB 0.50MB
datadog-iot-agent-aarch64-rpm 0.00MB 59.35MB 59.35MB 0.50MB

Decision

✅ Passed

Copy link

cit-pr-commenter bot commented May 22, 2025

Regression Detector

Regression Detector Results

Metrics dashboard
Target profiles
Run ID: 705ba47f-c936-40e8-a5a2-8c607cf61754

Baseline: 79129e1
Comparison: b17ea2b
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.20 [+1.09, +1.30] 1 Logs
docker_containers_cpu % cpu utilization +0.39 [-3.56, +4.34] 1 Logs
quality_gate_idle memory utilization +0.31 [+0.24, +0.38] 1 Logs bounds checks dashboard
quality_gate_idle_all_features memory utilization +0.26 [+0.17, +0.36] 1 Logs bounds checks dashboard
file_tree memory utilization +0.15 [+0.01, +0.30] 1 Logs
file_to_blackhole_1000ms_latency egress throughput +0.08 [-0.55, +0.71] 1 Logs
file_to_blackhole_100ms_latency egress throughput +0.05 [-0.59, +0.68] 1 Logs
otlp_ingest_logs memory utilization +0.03 [-0.10, +0.15] 1 Logs
file_to_blackhole_0ms_latency_http2 egress throughput +0.00 [-0.59, +0.60] 1 Logs
file_to_blackhole_1000ms_latency_linear_load egress throughput +0.00 [-0.23, +0.24] 1 Logs
otlp_ingest_metrics memory utilization -0.00 [-0.16, +0.16] 1 Logs
file_to_blackhole_0ms_latency_http1 egress throughput -0.00 [-0.59, +0.58] 1 Logs
tcp_dd_logs_filter_exclude ingress throughput -0.01 [-0.03, +0.02] 1 Logs
uds_dogstatsd_to_api ingress throughput -0.01 [-0.30, +0.27] 1 Logs
file_to_blackhole_300ms_latency egress throughput -0.02 [-0.65, +0.61] 1 Logs
file_to_blackhole_0ms_latency egress throughput -0.04 [-0.66, +0.59] 1 Logs
uds_dogstatsd_to_api_cpu % cpu utilization -0.07 [-0.95, +0.82] 1 Logs
file_to_blackhole_500ms_latency egress throughput -0.08 [-0.66, +0.50] 1 Logs
ddot_metrics memory utilization -0.29 [-0.41, -0.18] 1 Logs
docker_containers_memory memory utilization -0.34 [-0.39, -0.29] 1 Logs
uds_dogstatsd_20mb_12k_contexts_20_senders memory utilization -0.47 [-0.52, -0.43] 1 Logs
ddot_logs memory utilization -0.61 [-0.75, -0.47] 1 Logs
quality_gate_logs % cpu utilization -4.16 [-6.87, -1.45] 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:

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

@agent-platform-auto-pr
Copy link
Contributor

agent-platform-auto-pr bot commented May 22, 2025

Static quality checks

✅ Please find below the results from static quality gates
Comparison made with ancestor 79129e1

Successful checks

Info

Quality gate Delta On disk size (MiB) Delta On wire size (MiB)
agent_deb_amd64 $${\color{red}+0}$$ $${\color{green}746.96}$$ < $${752.99}$$ $${\color{red}+0.03}$$ $${\color{green}184.92}$$ < $${187.44}$$
agent_deb_amd64_fips $${\color{green}-0}$$ $${\color{green}745.32}$$ < $${751.36}$$ $${\color{green}-0.02}$$ $${\color{green}184.33}$$ < $${187.06}$$
agent_heroku_amd64 $${\color{red}+0}$$ $${\color{green}369.02}$$ < $${369.68}$$ $${\color{green}-0}$$ $${\color{green}98.67}$$ < $${99.55}$$
agent_msi $${\color{green}0}$$ $${\color{green}985.98}$$ < $${986.01}$$ $${\color{green}-0.01}$$ $${\color{green}149.71}$$ < $${149.72}$$
agent_rpm_amd64 $${\color{red}+0}$$ $${\color{green}746.95}$$ < $${752.98}$$ $${\color{green}-0}$$ $${\color{green}186.54}$$ < $${190.03}$$
agent_rpm_amd64_fips $${\color{green}-0}$$ $${\color{green}745.31}$$ < $${751.35}$$ $${\color{green}-0.01}$$ $${\color{green}186.27}$$ < $${189.81}$$
agent_rpm_arm64 $${\color{green}-0}$$ $${\color{green}733.71}$$ < $${739.42}$$ $${\color{red}+0.04}$$ $${\color{green}168.6}$$ < $${171.23}$$
agent_rpm_arm64_fips $${\color{green}-0}$$ $${\color{green}732.2}$$ < $${737.91}$$ $${\color{red}+0.01}$$ $${\color{green}167.65}$$ < $${170.22}$$
agent_suse_amd64 $${\color{red}+0}$$ $${\color{green}746.95}$$ < $${752.98}$$ $${\color{green}-0}$$ $${\color{green}186.54}$$ < $${190.03}$$
agent_suse_amd64_fips $${\color{green}-0}$$ $${\color{green}745.31}$$ < $${751.35}$$ $${\color{green}-0.01}$$ $${\color{green}186.27}$$ < $${189.81}$$
agent_suse_arm64 $${\color{green}-0}$$ $${\color{green}733.71}$$ < $${739.42}$$ $${\color{red}+0.04}$$ $${\color{green}168.6}$$ < $${171.23}$$
agent_suse_arm64_fips $${\color{green}-0}$$ $${\color{green}732.2}$$ < $${737.91}$$ $${\color{red}+0.01}$$ $${\color{green}167.65}$$ < $${170.22}$$
docker_agent_amd64 $${\color{red}+0}$$ $${\color{green}830.74}$$ < $${849.39}$$ $${\color{red}+0}$$ $${\color{green}282.06}$$ < $${288.34}$$
docker_agent_arm64 $${\color{green}-0}$$ $${\color{green}840.96}$$ < $${858.97}$$ $${\color{green}-0}$$ $${\color{green}268.19}$$ < $${274.36}$$
docker_agent_jmx_amd64 $${\color{red}+0}$$ $${\color{green}830.74}$$ < $${849.39}$$ $${\color{red}+0}$$ $${\color{green}282.06}$$ < $${288.34}$$
docker_agent_jmx_arm64 $${\color{green}-0}$$ $${\color{green}840.96}$$ < $${858.97}$$ $${\color{green}-0}$$ $${\color{green}268.19}$$ < $${274.36}$$
docker_agent_windows1809 $${\color{red}+0}$$ $${\color{green}830.74}$$ < $${849.39}$$ $${\color{red}+0}$$ $${\color{green}282.06}$$ < $${288.34}$$
docker_agent_windows1809_core $${\color{red}+0}$$ $${\color{green}830.74}$$ < $${849.39}$$ $${\color{red}+0}$$ $${\color{green}282.06}$$ < $${288.34}$$
docker_agent_windows1809_core_jmx $${\color{red}+0}$$ $${\color{green}830.74}$$ < $${849.39}$$ $${\color{red}+0}$$ $${\color{green}282.06}$$ < $${288.34}$$
docker_agent_windows1809_jmx $${\color{red}+0}$$ $${\color{green}830.74}$$ < $${849.39}$$ $${\color{red}+0}$$ $${\color{green}282.06}$$ < $${288.34}$$
docker_agent_windows2022 $${\color{red}+0}$$ $${\color{green}830.74}$$ < $${849.39}$$ $${\color{red}+0}$$ $${\color{green}282.06}$$ < $${288.34}$$
docker_agent_windows2022_core $${\color{red}+0}$$ $${\color{green}830.74}$$ < $${849.39}$$ $${\color{red}+0}$$ $${\color{green}282.06}$$ < $${288.34}$$
docker_agent_windows2022_core_jmx $${\color{red}+0}$$ $${\color{green}830.74}$$ < $${849.39}$$ $${\color{red}+0}$$ $${\color{green}282.06}$$ < $${288.34}$$
docker_agent_windows2022_jmx $${\color{red}+0}$$ $${\color{green}830.74}$$ < $${849.39}$$ $${\color{red}+0}$$ $${\color{green}282.06}$$ < $${288.34}$$
docker_cluster_agent_amd64 $${\color{green}-0}$$ $${\color{green}259.04}$$ < $${259.73}$$ $${\color{red}+0}$$ $${\color{green}102.83}$$ < $${103.68}$$
docker_cluster_agent_arm64 $${\color{red}+0}$$ $${\color{green}273.48}$$ < $${274.24}$$ $${\color{red}+0}$$ $${\color{green}97.54}$$ < $${98.45}$$
docker_cws_instrumentation_amd64 $${\color{green}0}$$ $${\color{green}7.08}$$ < $${7.12}$$ $${\color{red}+0}$$ $${\color{green}2.95}$$ < $${3.29}$$
docker_cws_instrumentation_arm64 $${\color{green}0}$$ $${\color{green}6.69}$$ < $${6.92}$$ $${\color{green}-0}$$ $${\color{green}2.7}$$ < $${3.07}$$
docker_dogstatsd_amd64 $${\color{green}-0}$$ $${\color{green}38.9}$$ < $${39.57}$$ $${\color{green}-0}$$ $${\color{green}14.94}$$ < $${15.76}$$
docker_dogstatsd_arm64 $${\color{green}0}$$ $${\color{green}37.52}$$ < $${38.2}$$ $${\color{red}+0}$$ $${\color{green}13.96}$$ < $${14.83}$$
dogstatsd_deb_amd64 $${\color{green}0}$$ $${\color{green}30.58}$$ < $${31.52}$$ $${\color{red}+0}$$ $${\color{green}8.03}$$ < $${8.97}$$
dogstatsd_deb_arm64 $${\color{green}0}$$ $${\color{green}29.14}$$ < $${30.08}$$ $${\color{green}-0}$$ $${\color{green}6.97}$$ < $${7.92}$$
dogstatsd_rpm_amd64 $${\color{green}0}$$ $${\color{green}30.58}$$ < $${31.52}$$ $${\color{red}+0}$$ $${\color{green}8.04}$$ < $${8.98}$$
dogstatsd_suse_amd64 $${\color{green}0}$$ $${\color{green}30.58}$$ < $${31.52}$$ $${\color{red}+0}$$ $${\color{green}8.04}$$ < $${8.98}$$
iot_agent_deb_amd64 $${\color{green}0}$$ $${\color{green}59.97}$$ < $${60.17}$$ $${\color{green}-0}$$ $${\color{green}14.99}$$ < $${15.82}$$
iot_agent_deb_arm64 $${\color{green}0}$$ $${\color{green}56.7}$$ < $${56.94}$$ $${\color{red}+0}$$ $${\color{green}12.87}$$ < $${13.86}$$
iot_agent_deb_armhf $${\color{green}0}$$ $${\color{green}56.14}$$ < $${56.41}$$ $${\color{red}+0}$$ $${\color{green}12.99}$$ < $${13.86}$$
iot_agent_rpm_amd64 $${\color{green}0}$$ $${\color{green}59.97}$$ < $${60.18}$$ $${\color{green}-0}$$ $${\color{green}15.01}$$ < $${15.84}$$
iot_agent_rpm_arm64 $${\color{green}0}$$ $${\color{green}56.7}$$ < $${56.94}$$ $${\color{green}-0}$$ $${\color{green}12.88}$$ < $${13.76}$$
iot_agent_suse_amd64 $${\color{green}0}$$ $${\color{green}59.97}$$ < $${60.18}$$ $${\color{green}-0}$$ $${\color{green}15.01}$$ < $${15.84}$$

Copy link
Member

@wdhif wdhif left a comment

Choose a reason for hiding this comment

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

Hello 👋 It would be great to add some tests to verify that the devcontainer continues to work across the following use cases:

  • Using the devcontainer commands.
    • Functionality with IDEs (Visual Studio Code, Jetbrains).
  • Using skaffold commands.

Having these tests is important to avoid regressions for developers relying on the devcontainer for their work with the Datadog Agent.

@ofek
Copy link
Contributor Author

ofek commented May 28, 2025

Tests occurred in a separate PR as planned #37438

@ofek ofek force-pushed the ofek/devcontainer branch from 13cd48c to b17ea2b Compare May 28, 2025 19:13
@@ -23,7 +23,7 @@
DEVCONTAINER_DIR = ".devcontainer"
DEVCONTAINER_FILE = "devcontainer.json"
DEVCONTAINER_NAME = "datadog_agent_devcontainer"
DEVCONTAINER_IMAGE = "registry.ddbuild.io/ci/datadog-agent-devenv:1-arm64"
Copy link
Contributor

Choose a reason for hiding this comment

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

Are we still getting arm64 tag?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@github-actions github-actions bot added medium review PR review might take time and removed short review PR is simple enough to be reviewed quickly labels May 28, 2025
@@ -93,10 +96,9 @@ def setup(
"datadog_agent_devcontainer",
]
devcontainer["features"] = {}
devcontainer["remoteUser"] = "datadog"
Copy link
Member

Choose a reason for hiding this comment

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

Does this change mean that we now need root privileges to build the agent?

@ofek ofek force-pushed the ofek/devcontainer branch from b17ea2b to 433f693 Compare June 12, 2025 14:54
@ofek ofek marked this pull request as draft June 12, 2025 14:54
@ofek
Copy link
Contributor Author

ofek commented Jun 12, 2025

The previous commit illustrates what choosing the user would look like and must be used on this branch that modifies the developer image: DataDog/datadog-agent-buildimages@main...ofek/user

This strategy will not work so I am instead allocating my time on making our tooling replacing and satisfying the core functionality of the devcontainer setup.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
changelog/no-changelog do-not-merge/hold medium review PR review might take time qa/no-code-change No code change in Agent code requiring validation team/container-platform The Container Platform Team
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants