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

[CONTINT-3744] Fill the repo_digests field in the SBOM payloads #22161

Merged
merged 5 commits into from
Jan 24, 2024

Conversation

L3n41c
Copy link
Member

@L3n41c L3n41c commented Jan 18, 2024

What does this PR do?

Add a repo_digests field to the sbom message.

Motivation

The backend currently indexes the sboms by repo digests.
It currently has to look for it as a trivy-specific property inside the CycloneDX SBOM.
Having the field available in a dedicated field in SBOMPayload will make the process less dependent on potential future trivy changes.

Additional Notes

Requires DataDog/agent-payload#283.

Possible Drawbacks / Trade-offs

Describe how to test/QA your changes

The easiest way to validate that the new repo_digests field is properly filled is to configure the agent to send SBOM payloads to the fake intake and to inspect the payloads with fakeintakectl.

fakeintakectl --url http://… filter sbom --id ghcr.io/datadog/apps-nginx-server@sha256:de5c472beb90fb7b4726b1a56b15076b06f2857f8836ed4535f09ead70b37582
[
  {
    "type": 1,
    "id": "ghcr.io/datadog/apps-nginx-server@sha256:de5c472beb90fb7b4726b1a56b15076b06f2857f8836ed4535f09ead70b37582",
    "repo_tags": [
      "main"
    ],
    "inUse": true,
    "dd_tags": [],
    "Sbom": {},
    "status": 1,
    "repo_digests": [
      "ghcr.io/datadog/apps-nginx-server@sha256:625f62fb6ebb306741285fbb600b62d9fa93a11215b9f3c9a51393b04913de2c"
    ]
  },

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. Except if the qa/skip-qa label, with required either qa/done or qa/no-code-change labels, are 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
Copy link

pr-commenter bot commented Jan 18, 2024

Bloop Bleep... Dogbot Here

Regression Detector Results

Run ID: 6fac5d70-6306-436a-a2bf-89f9e3be409d
Baseline: 81d31a4
Comparison: beaef52
Total CPUs: 7

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

No significant changes in experiment optimization goals

Confidence level: 90.00%
Effect size tolerance: |Δ mean %| ≥ 5.00%

There were no significant changes in experiment optimization goals at this confidence level and effect size tolerance.

Experiments ignored for regressions

Regressions in experiments with settings containing erratic: true are ignored.

perf experiment goal Δ mean % Δ mean % CI
idle memory utilization +0.48 [+0.44, +0.52]
file_to_blackhole % cpu utilization -0.45 [-6.99, +6.08]
file_tree memory utilization -1.65 [-1.72, -1.57]

Fine details of change detection per experiment

perf experiment goal Δ mean % Δ mean % CI
idle memory utilization +0.48 [+0.44, +0.52]
process_agent_standard_check_with_stats memory utilization +0.31 [+0.25, +0.37]
process_agent_standard_check memory utilization +0.31 [+0.24, +0.37]
process_agent_real_time_mode memory utilization +0.17 [+0.12, +0.22]
trace_agent_json ingress throughput +0.10 [+0.07, +0.13]
trace_agent_msgpack ingress throughput +0.02 [-0.00, +0.04]
tcp_dd_logs_filter_exclude ingress throughput +0.00 [-0.05, +0.05]
uds_dogstatsd_to_api ingress throughput -0.00 [-0.04, +0.04]
tcp_syslog_to_blackhole ingress throughput -0.20 [-0.27, -0.14]
file_to_blackhole % cpu utilization -0.45 [-6.99, +6.08]
uds_dogstatsd_to_api_cpu % cpu utilization -0.75 [-2.19, +0.68]
otel_to_otel_logs ingress throughput -0.95 [-1.71, -0.18]
file_tree memory utilization -1.65 [-1.72, -1.57]

Explanation

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".

Copy link
Contributor

@pducolin pducolin left a comment

Choose a reason for hiding this comment

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

Ok for gomod changes

@L3n41c L3n41c changed the title Fill the repo_digests field in the SBOM payloads [CONTINT-3744] Fill the repo_digests field in the SBOM payloads Jan 24, 2024
Copy link
Contributor

@clamoriniere clamoriniere left a comment

Choose a reason for hiding this comment

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

The changes look good.

@L3n41c do we have the same info already provided in the container_image payload?

@L3n41c
Copy link
Member Author

L3n41c commented Jan 24, 2024

@clamoriniere :

@L3n41c do we have the same info already provided in the container_image payload?

Yes, we have exactly the same logic in the container_image check:

repoDigests := make([]string, 0, 1)
for _, repoDigest := range img.RepoDigests {
if strings.HasPrefix(repoDigest, repo+"@sha256:") {
repoDigests = append(repoDigests, repoDigest)
}
}

@L3n41c
Copy link
Member Author

L3n41c commented Jan 24, 2024

/merge

@dd-devflow
Copy link

dd-devflow bot commented Jan 24, 2024

🚂 MergeQueue

This merge request is not mergeable yet, because of pending checks/missing approvals. It will be added to the queue as soon as checks pass and/or get approvals.
Note: if you pushed new commits since the last approval, you may need additional approval.
You can remove it from the waiting list with /remove command.

Use /merge -c to cancel this operation!

@dd-devflow
Copy link

dd-devflow bot commented Jan 24, 2024

🚂 MergeQueue

Added to the queue.

There are 3 builds ahead of this PR! (estimated merge in less than 1h)

Use /merge -c to cancel this operation!

@dd-mergequeue dd-mergequeue bot merged commit e717035 into main Jan 24, 2024
215 checks passed
@dd-mergequeue dd-mergequeue bot deleted the lenaic/sbom_repo_digests branch January 24, 2024 17:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants