init commit debug utils

[clarkb7]

What does this PR do?

Add invoke tasks (and helpers) to

• download coredump file from Gitlab job artifacts
  • e.g. from an E2E test
• download Agent debug symbols from Gitlab job artifacts (auto-finds the package build job in the pipeline)
• download Agent debug symbols for released versions

implemented fetch/extract for windows, suse, and debian debug packages.

• some tools may be required, such as rpm2cpio and dpkg-deb

# download dump from 681900370 and symbols from pipeline and launch delve
inv debugging.debug-job-dump --job-id 681900370 --platform windows
# download symbols from pipeline
inv debugging.get-debug-symbols --job-id 681900370 --platform debian
# download symbols for version
inv debugging.dump.get-debug-symbols --version 7.57.0 --platform windows

persists/caches downloaded files into ~/.agent-crash-analyzer/

/home/brandenclark/.agent-crash-analyzer
├── artifacts
│   └── datadog-agent
│       ├── 681900223
│       ├── 681900226
│       ├── 681900227
│       └── 681900370
└── symbols
    ├── 7.57.0
    │   ├── debian
    │   │   ├── arm64
    │   │   └── x86_64
    │   ├── suse
    │   │   └── x86_64
    │   └── windows
    │       └── x86_64
    └── 7.58.0-installer-0.6.0.git.119.b718ef8.pipeline.47264433
        ├── debian
        │   └── x86_64
        ├── suse
        │   ├── arm64
        │   └── x86_64
        └── windows
            └── x86_64

Motivation

automation

• very clicky to get artifacts/symbols/dumps
• debug packages for different platforms are in different places, jobs, can be hard to find

based on info from https://datadoghq.atlassian.net/wiki/spaces/agent/pages/3777987099/Loading+an+agent+core+dump

Describe how to test/QA your changes

run unit tests

cd tasks/debugging; inv invoke-unit-tests.run -v 2

run some of the invoke tasks and see if you get symbols/dumps

Possible Drawbacks / Trade-offs

there doesn't seem to be a way to list artifacts or download a specific artifact, so all the artifacts get downloaded.
This is nice for e2e test artifacts because you get the dump and the agent logs
but is not nice for package build artifacts when we only care about the debug symbol archive and the other artifacts are large. maybe we could upload the debug packages to the mstesting bucket, too.

Additional Notes

Not sure where to get debug symbols for release candidate builds for Linux platforms

[cit-pr-commenter]

Regression Detector

[agent-platform-auto-pr]

[Fast Unit Tests Report]

On pipeline 47920908 (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

[KevinFairise2]

I think we should be able to compute using that function:

datadog-agent/tasks/agent.py

Lines 777 to 789 in b738388

	@task
	def version(
	ctx,
	url_safe=False,
	omnibus_format=False,
	git_sha_length=7,
	major_version='7',
	cache_version=False,
	pipeline_id=None,
	include_git=True,
	include_pre=True,
	release=False,
	):

But not sure what parameters you would need to pass.
If that works like that I guess this is fine for a first PR

[clarkb7]

this leads to query_version which runs git commands. If those commands support being given a refspec i might be able to give it commit hash from the pipeline, but it would only work if you have the refspec locally, too. it might be nice to have a clone of the repo at that commit, though, so the source matches.

[clarkb7]

/merge

[dd-devflow]

🚂 MergeQueue: pull request added to the queue

The median merge time in main is 22m.

Use /merge -c to cancel this operation!