Refactor SBOM configuration parameters

[L3n41c]

What does this PR do?

Refactor the configuration parameters used to configure the SBOM collection.

Motivation

• Make the feature activable with only config param instead of requiring the creation of conf.d files.
• Rationalize the config layout (everything under sbom. root config section, container and host settings at the same level)

Additional Notes

The current settings:

      conf.d/container_lifecycle.d/conf.yaml existence (A) # to schedule the container lifecycle long running check
      conf.d/container_image.d/conf.yaml     existence (B) # to schedule the container image metadata long running check
      conf.d/sbom.d/conf.yaml                existence (C) # to schedule the sbom long running check

      Inside datadog.yaml:

      container_lifecycle:
        enabled:                        (D)  # Used to control the start of the container_lifecycle forwarder but has been decommissioned by #16084 (7.45.0-rc)
        dd_url:                              # \
        additional_endpoints:                # |
        use_compression:                     # |
        compression_level:                   #  > generic parameters for the generic EVP pipeline
          …                                  # |
        use_v2_api:                          # /

      container_image:
        enabled:                        (E)  # Used to control the start of the container_image forwarder but has been decommissioned by #16084 (7.45.0-rc)
        dd_url:                              # \
        additional_endpoints:                # |
        use_compression:                     # |
        compression_level:                   #  > generic parameters for the generic EVP pipeline
          …                                  # |
        use_v2_api:                          # /

      sbom:
        enabled:                        (F)  # control host SBOM collection and do *not* control container related sbom since #16084 (7.45.0-rc)
        dd_url:                              # \
        additional_endpoints:                # |
        use_compression:                     # |
        compression_level:                   #  > generic parameters for the generic EVP pipeline
          …                                  # |
        use_v2_api:                          # /
        analyzers:                      (G)  # trivy analyzers used for host SBOM collection
        cache_directory:                (H)
        clear_cache_on_exit:            (I)
        use_custom_cache:               (J)
        custom_cache_max_disk_size:     (K)
        custom_cache_max_cache_entries: (L)
        cache_clean_interval:           (M)

      container_image_collection:
        metadata:
          enabled:                      (N)  # Controls the collection of the container image metadata in workload meta
        sbom:
          enabled:                      (O)
          use_mount:                    (P)
          scan_interval:                (Q)
          scan_timeout:                 (R)
          analyzers:                    (S)  # trivy analyzers used for containers SBOM collection
          check_disk_usage:             (T)
          min_available_disk:           (U)

are turned into:

      conf.d/{container_lifecycle,container_image,sbom}.d/conf.yaml don’t need to be created by the users anymore. A default version is always shipped with the agent docker image with an underscore-prefixed ad_identifier that will be synthetised by the agent at runtime based on config {container_lifecycle,container_image,sbom}.enabled parameters.

      Inside datadog.yaml:

      container_lifecycle:
        enabled:                        (A)  # Replaces the need of creating a conf.d/container_lifecycle.d/conf.yaml file
        dd_url:                              # \
        additional_endpoints:                # |
        use_compression:                     # |
        compression_level:                   #  > unchanged generic parameters for the generic EVP pipeline
          …                                  # |
        use_v2_api:                          # /

      container_image:
        enabled:                        (B)  # Replaces the need of creating a conf.d/container_image.d/conf.yaml file
        dd_url:                              # \
        additional_endpoints:                # |
        use_compression:                     # |
        compression_level:                   #  > unchanged generic parameters for the generic EVP pipeline
          …                                  # |
        use_v2_api:                          # /

      sbom:
        enabled:                        (C)  # Replaces the need of creating a conf.d/sbom.d/conf.yaml file
        dd_url:                              # \
        additional_endpoints:                # |
        use_compression:                     # |
        compression_level:                   #  > unchanged generic parameters for the generic EVP pipeline
          …                                  # |
        use_v2_api:                          # /
        cache_directory:                (H)
        clear_cache_on_exit:            (I)
        cache:                               # Factorize all settings related to the custom cache
          enabled:                      (J)
          max_disk_size:                (K)
          max_cache_entries:            (L)
          clean_interval:               (M)

        host:                                # for host SBOM parameters that were directly below `sbom` before.
          enabled:                      (F)  # sbom.host.enabled replaces sbom.enabled
          analyzers:                    (G)  # sbom.host.analyzers replaces sbom.analyzers

        container_image:                     # sbom.container_image replaces container_image_collection.sbom
          enabled:                      (O)
          use_mount:                    (P)
          scan_interval:                (Q)
          scan_timeout:                 (R)
          analyzers:                    (S)    # trivy analyzers used for containers SBOM collection
          check_disk_usage:             (T)
          min_available_disk:           (U)

Those settings are affecting a beta feature and were not publicly documented. That’s why there’s no backward compatibility guaranteed.

Possible Drawbacks / Trade-offs

Describe how to test/QA your changes

Validate that the SBOM collection feature is working and honors the settings with their new names.

Reviewer's Checklist

• If known, an appropriate milestone has been selected; otherwise the Triage milestone is set.
• Use the major_change label if your change either has a major impact on the code base, is impacting multiple teams or is changing important well-established internals of the Agent. This label will be use during QA to make sure each team pay extra attention to the changed behavior. For any customer facing change use a releasenote.
• A release note has been added or the changelog/no-changelog label has been applied.
• Changed code has automated tests for its functionality.
• Adequate QA/testing plan information is provided if the qa/skip-qa label is not applied.
• At least one team/.. label has been applied, indicating the team(s) that should QA this change.
• If applicable, docs team has been notified or an issue has been opened on the documentation repo.
• If applicable, the need-change/operator and need-change/helm labels have been applied.
• If applicable, the k8s/<min-version> label, indicating the lowest Kubernetes version compatible with this feature.
• If applicable, the config template has been updated.

[pr-commenter]

Bloop Bleep... Dogbot Here

Regression Detector Results

Run ID: 5ba0bc82-57af-4127-8923-00d82927e54d
Baseline: 66271da
Comparison: abb733d
Total datadog-agent CPUs: 7

Explanation

A regression test is an integrated performance test for datadog-agent in a repeatable rig, with varying configuration for datadog-agent. What follows is a statistical summary of a brief datadog-agent run for each configuration across SHAs given above. The goal of these tests are to determine quickly if datadog-agent performance is changed and to what degree by a pull request.

Because a target's optimization goal performance in each experiment will vary somewhat each time it is run, we can only estimate mean differences in optimization goal relative to the baseline target. We express these differences as a percentage change relative to the baseline target, denoted "Δ mean %". These estimates are made to a precision that balances accuracy and cost control. We represent this precision as a 90.00% confidence interval denoted "Δ mean % CI": there is a 90.00% chance that the true value of "Δ mean %" is in that interval.

We decide whether a change in performance is a "regression" -- a change worth investigating further -- if both of the following two criteria are true:

1. The estimated |Δ mean %| ≥ 5.00%. This criterion intends to answer the question "Does the estimated change in mean optimization goal performance have a meaningful impact on your customers?". We assume that when |Δ mean %| < 5.00%, the impact on your customers is not meaningful. We also assume that a performance change in optimization goal is worth investigating whether it is an increase or decrease, so long as the magnitude of the change is sufficiently large.

2. Zero is not in the 90.00% confidence interval "Δ mean % CI" about "Δ mean %". This statement is equivalent to saying that there is at least a 90.00% chance that the mean difference in optimization goal is not zero. This criterion intends to answer the question, "Is there a statistically significant difference in mean optimization goal performance?". It also means there is no more than a 10.00% chance this criterion reports a statistically significant difference when the true difference in mean optimization goal is zero -- a "false positive". We assume you are willing to accept a 10.00% chance of inaccurately detecting a change in performance when no true difference exists.

The table below, if present, lists those experiments that have experienced a statistically significant change in mean optimization goal performance between baseline and comparison SHAs with 90.00% confidence OR have been detected as newly erratic. Negative values of "Δ mean %" mean that baseline is faster, whereas positive values of "Δ mean %" mean that comparison is faster. Results that do not exhibit more than a ±5.00% change in their mean optimization goal are discarded. An experiment is erratic if its coefficient of variation is greater than 0.1. The abbreviated table will be omitted if no interesting change is observed.

Changes in experiment optimization goals with confidence ≥ 90.00% and |Δ mean %| ≥ 5.00%:

experiment	goal	Δ mean %	confidence
tcp_syslog_to_blackhole	ingress throughput	-5.06	100.00%

Fine details of change detection per experiment.

experiment	goal	Δ mean %	Δ mean % CI	confidence
tcp_dd_logs_filter_exclude	ingress throughput	+3.11	[+2.87, +3.35]	100.00%
uds_dogstatsd_to_api	ingress throughput	-0.48	[-1.50, +0.55]	44.83%
file_to_blackhole	ingress throughput	-0.48	[-0.60, -0.37]	100.00%
otel_to_otel_logs	ingress throughput	-0.86	[-0.96, -0.76]	100.00%
tcp_syslog_to_blackhole	ingress throughput	-5.06	[-5.17, -4.95]	100.00%

[drichards-87]

Left you some minor feedback from Docs and approved the PR.

[brycekahle]

Are the config values sbom.* even used in system-probe? I don't see config.SystemProbe being used anywhere.