chore(asm): add a ctypes based ddprof module

[juanjux]

Add a small and private ctypes-based _ddprof module and a script to download the .so binary (including it is not an option since it's 17mb) to ease using ddprof start and stop functions to profile specific parts of the tracer.

Signed-off-by: Juanjo Alvarez [email protected]## Checklist

• PR author has checked that all the criteria below are met
• The PR description includes an overview of the change
• The PR description articulates the motivation for the change
• The change includes tests OR the PR description describes a testing strategy
• The PR description notes risks associated with the change, if any
• Newly-added code is easy to change
• The change follows the library release note guidelines
• The change includes or references documentation updates if necessary
• Backport labels are set (if applicable)

Reviewer Checklist

• Reviewer has checked that all the criteria below are met
• Title is accurate
• All changes are related to the pull request's stated goal
• Avoids breaking API changes
• Testing strategy adequately addresses listed risks
• Newly-added code is easy to change
• Release note makes sense to a user of the library
• If necessary, author has acknowledged and discussed the performance implications of this PR as reported in the benchmarks PR comment
• Backport labels are set in a manner that is consistent with the release branch maintenance policy

[github-actions]

CODEOWNERS have been resolved as:

ddtrace/appsec/_ddprof.py                                               @DataDog/asm-python
ddtrace/appsec/ddprof_lib/download_ddprof.sh                            @DataDog/asm-python
hatch.toml                                                              @DataDog/python-guild

[github-actions]

CODEOWNERS have been resolved as:

ddtrace/appsec/ddprof.py                                                @DataDog/asm-python
.gitignore                                                              @DataDog/apm-core-python
ddtrace/appsec/_iast/_taint_tracking/__init__.py                        @DataDog/asm-python

[gnufede]

Looks good, maybe you can add some example script that calls start_profiling and stop_profiling to showcase the usage

[pr-commenter]

Benchmarks

Benchmark execution time: 2024-10-25 15:00:48

Comparing candidate commit 2480b57 in PR branch juanjux/ddprof-python-module with baseline commit d3485f2 in branch main.

Found 5 performance improvements and 0 performance regressions! Performance is the same for 383 metrics, 2 unstable metrics.

scenario:iast_aspects-format_map_aspect

• 🟩 execution_time [-525.919ns; -463.170ns] or [-9.195%; -8.098%]

scenario:iast_aspects-ospathbasename_aspect

• 🟩 execution_time [-492.665ns; -440.462ns] or [-13.176%; -11.780%]

scenario:iast_aspects-ospathdirname_aspect

• 🟩 execution_time [-725.191ns; -659.693ns] or [-16.549%; -15.054%]

scenario:iast_aspects-ospathsplit_aspect

• 🟩 execution_time [-368.071ns; -305.914ns] or [-8.705%; -7.235%]

scenario:iast_aspects-split_aspect

• 🟩 execution_time [-219.355ns; -198.714ns] or [-11.722%; -10.619%]

[taegyunkim]

Should it be used as the following?

from ddtrace.appsec._ddprof import ddprof

ddprof.ddprof_start_profiling()
# run something interesting to be profiled here
# probably using native extensions
ddprof.ddprof_stop_profiling()

[juanjux]

Should it be used as the following?

from ddtrace.appsec._ddprof import ddprof

ddprof.ddprof_start_profiling()
# run something interesting to be profiled here
# probably using native extensions
ddprof.ddprof_stop_profiling()

That's right (stop profiling has a parameter for the timeout to wait in milliseconds). There is not much complication on it.

[datadog-dd-trace-py-rkomorn]

Datadog Report

Branch report: juanjux/ddprof-python-module
Commit report: 2480b57
Test service: dd-trace-py

✅ 0 Failed, 1286 Passed, 0 Skipped, 29m 44.22s Total duration (7m 55.54s time saved)

[sanchda]

This is exactly why we build libdd_profiling.so and it's really exciting to see it used!