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

chore(devcontainer): add workdir option #32590

Merged
merged 1 commit into from
Jan 2, 2025

Conversation

wdhif
Copy link
Member

@wdhif wdhif commented Dec 31, 2024

What does this PR do?

Add the -w (--workdir) run argument to the Dev Container.

Motivation

This is useful to have the working directory of the Dev Container being /workspaces/datadog-agent.

Describe how you validated your changes

➜ devcontainer up --workspace-folder .
[1 ms] @devcontainers/cli 0.72.0. Node.js v23.3.0. darwin 24.2.0 arm64.
[778 ms] Start: Run: docker run --sig-proxy=false -a STDOUT -a STDERR --mount type=bind,source=/Users/wassim.dhif/go/src/github.com/DataDog/datadog-agent,target=/workspaces/datadog-agent,consistency=cached --mount source=/var/run/docker.sock,target=/var/run/docker.sock,type=bind,consistency=cached -l devcontainer.local_folder=/Users/wassim.dhif/go/src/github.com/DataDog/datadog-agent -l devcontainer.config_file=/Users/wassim.dhif/go/src/github.com/DataDog/datadog-agent/.devcontainer/devcontainer.json --cap-add=SYS_PTRACE --security-opt seccomp=unconfined -w /workspaces/datadog-agent --name datadog_agent_devcontainer --entrypoint /bin/sh -l devcontainer.metadata=[{"postStartCommand":"git config --global --add safe.directory /workspaces/datadog-agent && invoke -e install-tools && invoke -e deps","customizations":{"vscode":{"settings":{"go.toolsManagement.checkForUpdates":"local","go.useLanguageServer":true,"go.gopath":"/home/datadog/go","go.goroot":"/usr/local/go","go.buildTags":"systemd,datadog.no_waf,trivy,jetson,docker,zk,zlib,orchestrator,kubelet,cri,jmx,crio,zstd,etcd,python,podman,containerd,consul,ec2,oracle,netcgo,kubeapiserver,otlp","go.testTags":"systemd,datadog.no_waf,trivy,jetson,docker,zk,zlib,orchestrator,kubelet,cri,jmx,crio,zstd,etcd,python,podman,containerd,consul,ec2,oracle,netcgo,kubeapiserver,otlp","go.lintTool":"golangci-lint","go.lintOnSave":"package","go.lintFlags":["--build-tags","systemd,datadog.no_waf,trivy,jetson,docker,zk,zlib,orchestrator,kubelet,cri,jmx,crio,zstd,etcd,python,podman,containerd,consul,ec2,oracle,netcgo,kubeapiserver,otlp"],"[go]":{"editor.formatOnSave":true},"gopls":{"formatting.local":"github.com/DataDog/datadog-agent"}},"extensions":["golang.Go"]}},"mounts":["source=/var/run/docker.sock,target=/var/run/docker.sock,type=bind,consistency=cached"],"remoteUser":"datadog","remoteEnv":{"GITLAB_TOKEN":"${localEnv:GITLAB_TOKEN}"}}] registry.ddbuild.io/ci/datadog-agent-devenv:1-arm64 -c echo Container started
Container started
Running the postStartCommand from devcontainer.json...
[...]
go mod download && go mod tidy completed in 152.68s
{"outcome":"success","containerId":"6ffc95e540fa6001ec6ac0b426ff2e9367272a1ace5afd0d3e2f6a2fc3737402","remoteUser":"datadog","remoteWorkspaceFolder":"/workspaces/datadog-agent"}
➜  datadog-agent git:(main) docker exec -it datadog_agent_devcontainer bash
To run a command as administrator (user "root"), use "sudo <command>".
See "man sudo_root" for details.

datadog@6ffc95e540fa:/workspaces/datadog-agent$ ls
CHANGELOG-DCA.rst            LICENSE-3rdparty.csv  cmd           examples           go.work.sum              omnibus            releasenotes-dca             tasks
CHANGELOG-INSTALLSCRIPT.rst  Makefile.trace        comp          flakes.yaml        google-marketplace       pkg                repository.datadog.yml       test
CHANGELOG.rst                NOTICE                coverage.out  generate_tools.go  internal                 powershell-module  requirements.txt             tools
CONTRIBUTING.md              README.md             dev           go.mod             mkdocs.yml               pyproject.toml     rtloader                     venv
Dockerfiles                  SUPPORT.md            devenv        go.sum             module_test_output.json  release.json       service.datadog.yaml
LICENSE                      chocolatey            docs          go.work            modules.yml              releasenotes       static-analysis.datadog.yml

Notice the run argument -w /workspaces/datadog-agent in the docker run command used by the devcontainer CLI.

Possible Drawbacks / Trade-offs

N/A

Additional Notes

N/A

@wdhif wdhif added changelog/no-changelog qa/no-code-change No code change in Agent code requiring validation labels Dec 31, 2024
@wdhif wdhif requested review from a team as code owners December 31, 2024 17:48
@github-actions github-actions bot added the short review PR is simple enough to be reviewed quickly label Dec 31, 2024
@agent-platform-auto-pr
Copy link
Contributor

Uncompressed package size comparison

Comparison with ancestor 7396f6c4e5ccd20f8c8af631d519a9c14067af7f

Diff per package
package diff status size ancestor threshold
datadog-agent-amd64-deb 0.00MB 1191.04MB 1191.04MB 140.00MB
datadog-agent-x86_64-rpm 0.00MB 1200.36MB 1200.36MB 140.00MB
datadog-agent-x86_64-suse 0.00MB 1200.36MB 1200.36MB 140.00MB
datadog-agent-arm64-deb 0.00MB 935.37MB 935.37MB 140.00MB
datadog-agent-aarch64-rpm 0.00MB 944.67MB 944.67MB 140.00MB
datadog-dogstatsd-amd64-deb 0.00MB 78.54MB 78.54MB 10.00MB
datadog-dogstatsd-x86_64-rpm 0.00MB 78.62MB 78.62MB 10.00MB
datadog-dogstatsd-x86_64-suse 0.00MB 78.62MB 78.62MB 10.00MB
datadog-dogstatsd-arm64-deb 0.00MB 55.75MB 55.75MB 10.00MB
datadog-heroku-agent-amd64-deb 0.00MB 505.27MB 505.27MB 70.00MB
datadog-iot-agent-amd64-deb 0.00MB 113.34MB 113.34MB 10.00MB
datadog-iot-agent-x86_64-rpm 0.00MB 113.41MB 113.41MB 10.00MB
datadog-iot-agent-x86_64-suse 0.00MB 113.41MB 113.41MB 10.00MB
datadog-iot-agent-arm64-deb 0.00MB 108.81MB 108.81MB 10.00MB
datadog-iot-agent-aarch64-rpm 0.00MB 108.88MB 108.88MB 10.00MB

Decision

✅ Passed

@agent-platform-auto-pr
Copy link
Contributor

[Fast Unit Tests Report]

On pipeline 51951180 (CI Visibility). The following jobs did not run any unit tests:

Jobs:
  • tests_deb-arm64-py3
  • tests_deb-x64-py3
  • tests_flavor_dogstatsd_deb-x64
  • tests_flavor_heroku_deb-x64
  • tests_flavor_iot_deb-x64
  • tests_rpm-arm64-py3
  • tests_rpm-x64-py3
  • tests_windows-x64

If you modified Go files and expected unit tests to run in these jobs, please double check the job logs. If you think tests should have been executed reach out to #agent-devx-help

Copy link

Regression Detector

Regression Detector Results

Metrics dashboard
Target profiles
Run ID: da2d8bff-f455-4b43-82e0-f8608ae65219

Baseline: 7396f6c
Comparison: 777dbb7
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.34 [+0.26, +0.41] 1 Logs
file_tree memory utilization +0.15 [+0.01, +0.28] 1 Logs
file_to_blackhole_0ms_latency egress throughput +0.05 [-0.81, +0.90] 1 Logs
file_to_blackhole_300ms_latency egress throughput +0.04 [-0.60, +0.69] 1 Logs
file_to_blackhole_1000ms_latency_linear_load egress throughput +0.04 [-0.43, +0.51] 1 Logs
file_to_blackhole_0ms_latency_http2 egress throughput +0.02 [-0.82, +0.86] 1 Logs
uds_dogstatsd_to_api ingress throughput +0.02 [-0.10, +0.14] 1 Logs
tcp_dd_logs_filter_exclude ingress throughput +0.00 [-0.01, +0.01] 1 Logs
quality_gate_idle_all_features memory utilization -0.00 [-0.09, +0.08] 1 Logs bounds checks dashboard
file_to_blackhole_100ms_latency egress throughput -0.05 [-0.75, +0.66] 1 Logs
file_to_blackhole_0ms_latency_http1 egress throughput -0.08 [-0.97, +0.81] 1 Logs
quality_gate_idle memory utilization -0.12 [-0.16, -0.08] 1 Logs bounds checks dashboard
quality_gate_logs % cpu utilization -0.13 [-3.35, +3.10] 1 Logs
file_to_blackhole_1000ms_latency egress throughput -0.15 [-0.96, +0.66] 1 Logs
uds_dogstatsd_to_api_cpu % cpu utilization -0.23 [-0.90, +0.45] 1 Logs
file_to_blackhole_500ms_latency egress throughput -0.34 [-1.11, +0.43] 1 Logs

Bounds Checks: ❌ Failed

perf experiment bounds_check_name replicates_passed links
file_to_blackhole_0ms_latency lost_bytes 9/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 memory_usage 10/10 bounds checks dashboard
quality_gate_idle_all_features memory_usage 10/10 bounds checks dashboard
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, bounds check memory_usage: 10/10 replicas passed. Gate passed.
  • quality_gate_idle_all_features, 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.

@wdhif
Copy link
Member Author

wdhif commented Jan 2, 2025

/merge

@dd-devflow
Copy link

dd-devflow bot commented Jan 2, 2025

Devflow running: /merge

View all feedbacks in Devflow UI.


2025-01-02 10:33:55 UTC ℹ️ MergeQueue: pull request added to the queue

The median merge time in main is 35m.


2025-01-02 11:16:10 UTC ℹ️ MergeQueue: This merge request was merged

@dd-mergequeue dd-mergequeue bot merged commit c0ff95c into main Jan 2, 2025
234 checks passed
@dd-mergequeue dd-mergequeue bot deleted the dev/wassim.dhif/add-workdir-devcontainer branch January 2, 2025 11:16
@github-actions github-actions bot added this to the 7.63.0 milestone Jan 2, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
changelog/no-changelog qa/no-code-change No code change in Agent code requiring validation short review PR is simple enough to be reviewed quickly
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants