Skip to content

[ABLD-395] Framework to create toolchains for OS provided tools - #54154

Closed
aiuto wants to merge 5 commits into
mainfrom
aiuto/declare_tools
Closed

[ABLD-395] Framework to create toolchains for OS provided tools#54154
aiuto wants to merge 5 commits into
mainfrom
aiuto/declare_tools

Conversation

@aiuto

@aiuto aiuto commented Jul 28, 2026

Copy link
Copy Markdown
Collaborator

What does this PR do?

  • Creates a tiny framework for finding an OS provided tool and telling Bazel it is a toolchain.
  • Use it for macos pkgbuild and codesign.

The important feature of the way this is implemented is that the toolchain always safely resolves on all platforms, so you can bazel cquery across platforms, even though you will fail if you try to build. Combined with exec_compatible_with you can make targets that only build if the required tools are available. This is important when there are different tools available as OSes evolve (or are simply different by vendor, like debian and redhat) and we need to create paths that can gracefully use different tools depending on what is available.

Motivation

This is an important part of our supply chain security posture. We want to account for every binary we use to build the product. Ideally that would include even basic low level things, like bash and cat. In practice we can make the tradeoff to stop at declaring the things that might vary across OSes or from OS release to release.

Eventually, we will expand this the framework to include package metadata (https://github.com/bazel-contrib/supply-chain/tree/main/metadata) that can be easily gathered into a workspace BOM.

The more immediate need is to create toolchains for pkgbuild and codesign to create rules to make macos packages. #54115

Describe how you validated your changes

With the BUILD file

genrule(
    name = "test",
    cmd = select({
        "@macos_codesign//:have_codesign": "echo GOT IT",
        "//conditions:default": "echo wump, wump, wump",
    }),
    outs = ["test.out"],
)

macos:

$ bazel cquery --output=build  //ztony:test
genrule(
  name = "test",
  outs = ["//ztony:test.out"],
  cmd = "echo GOT IT",
)
$ bazel cquery @macos_codesign//:all
INFO: Analyzed 7 targets (0 packages loaded, 6 targets configured).
INFO: Found 7 targets...
@macos_codesign//:codesign_auto (eab6d8f)
@macos_codesign//:codesign_toolchain (eab6d8f)
@macos_codesign//:codesign_toolchain_type (eab6d8f)
@macos_codesign//:have_codesign (eab6d8f)
@macos_codesign//:is_codesign_available (eab6d8f)
@macos_codesign//:no_codesign (eab6d8f)
@macos_codesign//:zzz_codesign_missing_toolchain (eab6d8f)

linux:

$ bazel cquery --output=build  //ztony:test
genrule(
  name = "test",
  outs = ["//ztony:test.out"],
  cmd = "echo wump, wump, wump",
)
$ bazel cquery @macos_codesign//:all
@macos_codesign//:codesign_auto (a938602)
@macos_codesign//:codesign_toolchain (a938602)
@macos_codesign//:codesign_toolchain_type (a938602)
@macos_codesign//:have_codesign (a938602)
@macos_codesign//:is_codesign_available (a938602)
@macos_codesign//:no_codesign (a938602)
@macos_codesign//:zzz_codesign_missing_toolchain (a938602)

Additional

ABLD-386

WHAT
- Creates a tiny framework for finding an OS provided tool and telling Bazel it is a toolchain.
- Use it for Macos pkgbuild and codesign.

MOTIV

This is an important part of our supply chain security posture. We want to account for every binary we use to build the product. Ideally that would include even basic low level things, like bash and cat. In practice we just want to declare the things that might vary across OSes or from OS release to release.

Eventually, we will expand this the framework to include package metadata (https://github.com/bazel-contrib/supply-chain/tree/main/metadata) that can be easily gathered into a workspace BOM.

The more immediate need is to create toolchains for pkgbuild and codesign to create rules to make macos packages.
#54115
@aiuto aiuto added changelog/no-changelog No changelog entry needed qa/no-code-change No code change in Agent code requiring validation labels Jul 28, 2026
@dd-octo-sts dd-octo-sts Bot added internal Identify a non-fork PR team/agent-build labels Jul 28, 2026
@github-actions github-actions Bot added the medium review PR review might take time label Jul 28, 2026
chatgpt-codex-connector[bot]

This comment was marked as outdated.

@dd-octo-sts

dd-octo-sts Bot commented Jul 28, 2026

Copy link
Copy Markdown
Contributor

Files inventory check summary

File checks results against ancestor 44a9fcf1:

Results for datadog-agent_7.83.0~devel.git.421.cad9410.pipeline.127422368-1_amd64.deb:

No change detected

@aiuto
aiuto marked this pull request as ready for review July 28, 2026 04:20
@aiuto
aiuto requested a review from a team as a code owner July 28, 2026 04:20
@github-actions github-actions Bot added long review PR is complex, plan time to review it and removed medium review PR review might take time labels Jul 28, 2026

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: 446ae551af

ℹ️ About Codex in GitHub

Codex has been enabled to automatically review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

When you sign up for Codex through ChatGPT, Codex can also answer questions or update the PR, like "@codex address that feedback".

Comment thread bazel/toolchains/common/toolchain_BUILD.tpl
@dd-octo-sts

dd-octo-sts Bot commented Jul 28, 2026

Copy link
Copy Markdown
Contributor

Static quality checks

✅ Please find below the results from static quality gates
Comparison made with ancestor 44a9fcf
📊 Static Quality Gates Dashboard
🔗 SQG Job

33 successful checks with minimal change (< 2 KiB)
Quality gate Current Size
agent_deb_amd64 752.120 MiB
agent_deb_amd64_fips 706.893 MiB
agent_heroku_amd64 308.048 MiB
agent_msi 640.291 MiB
agent_rpm_amd64 752.104 MiB
agent_rpm_amd64_fips 706.877 MiB
agent_rpm_arm64 728.690 MiB
agent_rpm_arm64_fips 686.617 MiB
agent_suse_amd64 752.104 MiB
agent_suse_amd64_fips 706.877 MiB
agent_suse_arm64 728.690 MiB
agent_suse_arm64_fips 686.617 MiB
docker_agent_amd64 810.787 MiB
docker_agent_arm64 812.429 MiB
docker_agent_jmx_amd64 1001.684 MiB
docker_agent_jmx_arm64 991.979 MiB
docker_cluster_agent_amd64 209.887 MiB
docker_cluster_agent_arm64 222.953 MiB
docker_cws_instrumentation_amd64 7.439 MiB
docker_cws_instrumentation_arm64 6.877 MiB
docker_dogstatsd_amd64 39.255 MiB
docker_dogstatsd_arm64 37.368 MiB
docker_host_profiler_amd64 305.017 MiB
docker_host_profiler_arm64 316.336 MiB
dogstatsd_deb_amd64 30.000 MiB
dogstatsd_deb_arm64 28.035 MiB
dogstatsd_rpm_amd64 30.000 MiB
dogstatsd_suse_amd64 30.000 MiB
iot_agent_deb_amd64 46.181 MiB
iot_agent_deb_arm64 42.868 MiB
iot_agent_deb_armhf 43.633 MiB
iot_agent_rpm_amd64 46.181 MiB
iot_agent_suse_amd64 46.180 MiB

@cit-pr-commenter-54b7da

cit-pr-commenter-54b7da Bot commented Jul 28, 2026

Copy link
Copy Markdown

Regression Detector

Regression Detector Results

Metrics dashboard
Target profiles
Run ID: ccaa67ea-ded0-48e8-90b3-a2f4751e1eb9

Baseline: 44a9fcf
Comparison: cad9410
Diff

Optimization Goals: ✅ No significant changes detected

Fine details of change detection per experiment

perf experiment goal Δ mean % Δ mean % CI trials links
quality_gate_security_idle memory utilization +0.45 [+0.39, +0.51] 1 Logs bounds checks dashboard
quality_gate_metrics_logs memory utilization +0.42 [+0.18, +0.67] 1 Logs bounds checks dashboard
quality_gate_private_action_runner memory utilization +0.25 [+0.12, +0.37] 1 Logs bounds checks dashboard
quality_gate_security_no_fs_load memory utilization +0.21 [+0.12, +0.31] 1 Logs bounds checks dashboard
quality_gate_security_mean_fs_load memory utilization +0.21 [+0.17, +0.24] 1 Logs bounds checks dashboard
quality_gate_idle memory utilization -0.16 [-0.21, -0.11] 1 Logs bounds checks dashboard
quality_gate_idle_all_features memory utilization -0.21 [-0.24, -0.17] 1 Logs bounds checks dashboard
quality_gate_logs % cpu utilization -0.43 [-1.43, +0.57] 1 Logs bounds checks dashboard

Bounds Checks: ✅ Passed

perf experiment bounds_check_name replicates_passed observed_value links
quality_gate_idle intake_connections 10/10 3 ≤ 4 bounds checks dashboard
quality_gate_idle memory_usage 10/10 147.91MiB ≤ 154MiB bounds checks dashboard
quality_gate_idle total_bytes_received 10/10 733.20KiB ≤ 819.20KiB bounds checks dashboard
quality_gate_idle_all_features intake_connections 10/10 3 ≤ 4 bounds checks dashboard
quality_gate_idle_all_features memory_usage 10/10 492.96MiB ≤ 512MiB bounds checks dashboard
quality_gate_idle_all_features total_bytes_received 10/10 1.12MiB ≤ 1.25MiB bounds checks dashboard
quality_gate_logs intake_connections 10/10 3 ≤ 6 bounds checks dashboard
quality_gate_logs memory_usage 10/10 188.99MiB ≤ 195MiB bounds checks dashboard
quality_gate_logs missed_bytes 10/10 0B = 0B bounds checks dashboard
quality_gate_logs total_bytes_received 10/10 264.18MiB ≤ 292MiB bounds checks dashboard
quality_gate_metrics_logs cpu_usage 10/10 365.68 ≤ 2000 bounds checks dashboard
quality_gate_metrics_logs intake_connections 10/10 4 ≤ 6 bounds checks dashboard
quality_gate_metrics_logs memory_usage 10/10 406.06MiB ≤ 430MiB bounds checks dashboard
quality_gate_metrics_logs missed_bytes 10/10 0B = 0B bounds checks dashboard
quality_gate_metrics_logs total_bytes_received 10/10 0.93GiB ≤ 1.04GiB bounds checks dashboard
quality_gate_private_action_runner memory_usage 10/10 71.29MiB ≤ 75MiB bounds checks dashboard
quality_gate_security_idle cpu_usage 10/10 30.15 ≤ 100 bounds checks dashboard
quality_gate_security_idle memory_usage 10/10 299.62MiB ≤ 330MiB bounds checks dashboard
quality_gate_security_mean_fs_load cpu_usage 10/10 63.64 ≤ 200 bounds checks dashboard
quality_gate_security_mean_fs_load memory_usage 10/10 279.30MiB ≤ 310MiB bounds checks dashboard
quality_gate_security_no_fs_load cpu_usage 10/10 24.02 ≤ 100 bounds checks dashboard
quality_gate_security_no_fs_load memory_usage 10/10 284.35MiB ≤ 320MiB 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".

Replicate Execution Details

We run multiple replicates for each experiment/variant. However, we allow replicates to be automatically retried if there are any failures, up to 8 times, at which point the replicate is marked dead and we are unable to run analysis for the entire experiment. We call each of these attempts at running replicates a replicate execution. This section lists all replicate executions that failed due to the target crashing or being oom killed.

Note: In the below tables we bucket failures by experiment, variant, and failure type. For each of these buckets we list out the replicate indexes that failed with an annotation signifying how many times said replicate failed with the given failure mode. In the below example the baseline variant of the experiment named experiment_with_failures had two replicates that failed by oom kills. Replicate 0, which failed 8 executions, and replicate 1 which failed 6 executions, all with the same failure mode.

Experiment Variant Replicates Failure Logs Debug Dashboard
experiment_with_failures baseline 0 (x8) 1 (x6) Oom killed Debug Dashboard

The debug dashboard links will take you to a debugging dashboard specifically designed to investigate replicate execution failures.

❌ Retried Profiling Replicate Execution Failures (ddprof)

Note: Profiling replicas may still be executing. See the debug dashboard for up to date status.

Experiment Variant Replicates Failure Debug Dashboard
quality_gate_idle baseline 10 Oom killed Debug Dashboard
quality_gate_idle_all_features baseline 10 Oom killed Debug Dashboard
quality_gate_idle_all_features comparison 10 Oom killed Debug Dashboard
quality_gate_logs baseline 10 Oom killed Debug Dashboard
quality_gate_logs comparison 10 Oom killed Debug Dashboard
quality_gate_metrics_logs baseline 10 Oom killed Debug Dashboard
quality_gate_metrics_logs comparison 10 Oom killed Debug Dashboard
quality_gate_security_idle baseline 10 Crashed (exit code: 134) Debug Dashboard
quality_gate_security_idle comparison 10 Crashed (exit code: 134) Debug Dashboard
quality_gate_security_mean_fs_load comparison 10 Crashed (exit code: 134) Debug Dashboard
quality_gate_security_no_fs_load baseline 10 Crashed (exit code: 134) Debug Dashboard
quality_gate_security_no_fs_load comparison 10 Crashed (exit code: 134) Debug Dashboard

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, bounds check total_bytes_received: 10/10 replicas passed. Gate passed.
  • quality_gate_security_idle, bounds check cpu_usage: 10/10 replicas passed. Gate passed.
  • quality_gate_security_idle, 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_idle_all_features, bounds check total_bytes_received: 10/10 replicas passed. Gate passed.
  • quality_gate_idle_all_features, bounds check memory_usage: 10/10 replicas passed. Gate passed.
  • quality_gate_metrics_logs, bounds check memory_usage: 10/10 replicas passed. Gate passed.
  • quality_gate_metrics_logs, bounds check missed_bytes: 10/10 replicas passed. Gate passed.
  • quality_gate_metrics_logs, bounds check cpu_usage: 10/10 replicas passed. Gate passed.
  • quality_gate_metrics_logs, bounds check intake_connections: 10/10 replicas passed. Gate passed.
  • quality_gate_metrics_logs, bounds check total_bytes_received: 10/10 replicas passed. Gate passed.
  • quality_gate_security_mean_fs_load, bounds check memory_usage: 10/10 replicas passed. Gate passed.
  • quality_gate_security_mean_fs_load, bounds check cpu_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 missed_bytes: 10/10 replicas passed. Gate passed.
  • quality_gate_logs, bounds check total_bytes_received: 10/10 replicas passed. Gate passed.
  • quality_gate_logs, bounds check intake_connections: 10/10 replicas passed. Gate passed.
  • quality_gate_security_no_fs_load, bounds check memory_usage: 10/10 replicas passed. Gate passed.
  • quality_gate_security_no_fs_load, bounds check cpu_usage: 10/10 replicas passed. Gate passed.
  • quality_gate_private_action_runner, bounds check memory_usage: 10/10 replicas passed. Gate passed.

@github-actions github-actions Bot added medium review PR review might take time and removed long review PR is complex, plan time to review it labels Jul 28, 2026
@aiuto

aiuto commented Jul 28, 2026

Copy link
Copy Markdown
Collaborator Author

To address the codex comment about exec_compatible_with, I did a complete alternate in #54177. I think I like that better because it is a straight up repository rule rather than a module extension.

@aiuto
aiuto marked this pull request as draft July 28, 2026 18:37
gh-worker-dd-mergequeue-cf854d Bot pushed a commit that referenced this pull request Aug 5, 2026
### What does this PR do?

- Creates a tiny framework for finding an OS provided tool and telling Bazel it is a toolchain.
- Use it for macos pkgbuild and codesign.

The important feature of the way this is implemented is that the toolchain always safely resolves on all platforms, so you can `bazel cquery` across platforms, even though you will fail if you try to `build`. Combined with `exec_compatible_with` you can make targets that only build if the required tools are available. This is important when there are different tools available as OSes evolve (or are simply different by vendor, like debian and redhat) and we need to create paths that can gracefully use different tools depending on what is available.

There is also a capability to use a bazel target as the tool implementation instead of looking it up in $PATH. That is useful for building alternate implementations (let's say a windows tool on linux). That will come into use in full remote execution mode, when the target and exec hosts can be different architectures.

**Examples:**
- I'm building a tarball, see if I have the xz toolchain and use that if available, otherwise fall back to a slower compresser
- The OS is evolving a tool, if we have version 1, it might have one name. In version 2, there might be a better tool. We want to make rules that can do the right thing regardless of what OS we have. This is a huge win for external users who may be using a different base linux to build.


### Motivation

This is an important part of our supply chain security posture. We want to account for every binary we use to build the product. Ideally that would include even basic low level things, like bash and cat. In practice we can make the tradeoff to stop at declaring the things that might vary across OSes or from OS release to release.

Eventually, we will expand this the framework to include package metadata (https://github.com/bazel-contrib/supply-chain/tree/main/metadata) that can be easily gathered into a workspace BOM.

The more immediate need is to create toolchains for pkgbuild and codesign to create rules to make macos packages. #54115

### Describe how you validated your changes
With the BUILD file
```
genrule(
    name = "test",
    cmd = select({
        "@macos_codesign//:have_codesign": "echo GOT IT",
        "//conditions:default": "echo wump, wump, wump",
    }),
    outs = ["test.out"],
)
```

macos:
```
$ bazel cquery --output=build  //ztony:test
genrule(
  name = "test",
  outs = ["//ztony:test.out"],
  cmd = "echo GOT IT",
)
$ bazel cquery @macos_codesign//:all
INFO: Analyzed 7 targets (0 packages loaded, 6 targets configured).
INFO: Found 7 targets...
@macos_codesign//:codesign_auto (eab6d8f)
@macos_codesign//:codesign_toolchain (eab6d8f)
@macos_codesign//:codesign_toolchain_type (eab6d8f)
@macos_codesign//:have_codesign (eab6d8f)
@macos_codesign//:is_codesign_available (eab6d8f)
@macos_codesign//:no_codesign (eab6d8f)
@macos_codesign//:zzz_codesign_missing_toolchain (eab6d8f)
```
linux:
```
$ bazel cquery --output=build  //ztony:test
genrule(
  name = "test",
  outs = ["//ztony:test.out"],
  cmd = "echo wump, wump, wump",
)
$ bazel cquery @macos_codesign//:all
@macos_codesign//:codesign_auto (a938602)
@macos_codesign//:codesign_toolchain (a938602)
@macos_codesign//:codesign_toolchain_type (a938602)
@macos_codesign//:have_codesign (a938602)
@macos_codesign//:is_codesign_available (a938602)
@macos_codesign//:no_codesign (a938602)
@macos_codesign//:zzz_codesign_missing_toolchain (a938602)
```



### Additional
This is an alternate version of #54154. I think I like it better.
[ABLD-386]: https://datadoghq.atlassian.net/browse/ABLD-386



Co-authored-by: tony.aiuto <tony.aiuto@datadoghq.com>
@aiuto aiuto closed this Aug 5, 2026
@aiuto
aiuto deleted the aiuto/declare_tools branch August 5, 2026 20:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

changelog/no-changelog No changelog entry needed internal Identify a non-fork PR medium review PR review might take time qa/no-code-change No code change in Agent code requiring validation team/agent-build

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant