Skip to content

Conversation

L3n41c
Copy link
Member

@L3n41c L3n41c commented May 30, 2024

What does this PR do?

Set the standard org.opencontainers.image.-prefixed labels on the docker images.

Motivation

We should at least set the labels that are used by the Datadog source code integration and captured by the agent here:

// Automatically extract git commit sha from image for source code integration
"org.opencontainers.image.revision": "git.commit.sha",
// Automatically extract repository url from image for source code integration
"org.opencontainers.image.source": "git.repository_url",

Although org.opencontainers.image.source was already set, org.opencontainers.image.revision was missing and org.opencontainers.image.version had a bad value because it was inherited from the base image:

$ docker inspect gcr.io/datadoghq/agent:7.54.0-rc.5  --format '{{ range $k, $v := .Config.Labels }}{{ $k }}={{ $v }}{{ "\n" }}{{ end }}'
baseimage.name=ubuntu:
baseimage.os=ubuntu 
maintainer=Datadog <package@datadoghq.com>
org.opencontainers.image.ref.name=ubuntu
org.opencontainers.image.source=https://github.com/DataDog/datadog-agent
org.opencontainers.image.version=23.10

Additional Notes

Possible Drawbacks / Trade-offs

Describe how to test/QA your changes

Check that the source code integration is working fine with the agent.

The set of labels of agent docker image should now be more complete:

$ docker inspect docker.io/datadog/agent-dev:lenaic-docker-images-std-labels-py3  --format '{{ range $k, $v := .Config.Labels }}{{ $k }}={{ $v }}{{ "\n" }}{{ end }}'
baseimage.name=ubuntu:23.10
baseimage.os=ubuntu mantic
maintainer=Datadog <package@datadoghq.com>
org.opencontainers.image.authors=Datadog <package@datadoghq.com>
org.opencontainers.image.base.name=ubuntu:23.10
org.opencontainers.image.created=2024-05-31 08:30:53+00:00
org.opencontainers.image.ref.name=ubuntu
org.opencontainers.image.revision=6e9e4a54168fb91bb01e1f682aeb24be1101f460
org.opencontainers.image.source=https://github.com/DataDog/datadog-agent
org.opencontainers.image.title=Datadog Agent
org.opencontainers.image.vendor=Datadog, Inc.
org.opencontainers.image.version=7.55.0-devel+git.586.6e9e4a5.pipeline.35547510

@L3n41c L3n41c added this to the 7.55.0 milestone May 30, 2024
@L3n41c L3n41c requested review from a team as code owners May 30, 2024 21:08
@agent-platform-auto-pr
Copy link
Contributor

agent-platform-auto-pr bot commented May 30, 2024

[Fast Unit Tests Report]

On pipeline 35547510 (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-developer-experience

@pr-commenter
Copy link

pr-commenter bot commented May 30, 2024

Regression Detector

Regression Detector Results

Run ID: f355707f-409f-4a1e-8c4f-0a36bf637c9a
Baseline: 9f39b07
Comparison: 6e9e4a5

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.

Fine details of change detection per experiment

perf experiment goal Δ mean % Δ mean % CI
basic_py_check % cpu utilization +2.31 [-0.68, +5.30]
tcp_syslog_to_blackhole ingress throughput +1.59 [-20.03, +23.20]
idle memory utilization +0.91 [+0.87, +0.94]
uds_dogstatsd_to_api_cpu % cpu utilization +0.22 [-2.71, +3.15]
tcp_dd_logs_filter_exclude ingress throughput +0.01 [-0.03, +0.04]
trace_agent_json ingress throughput +0.00 [-0.01, +0.01]
uds_dogstatsd_to_api ingress throughput +0.00 [-0.20, +0.20]
trace_agent_msgpack ingress throughput -0.00 [-0.00, +0.00]
otel_to_otel_logs ingress throughput -0.04 [-0.39, +0.31]
file_tree memory utilization -0.32 [-0.40, -0.24]
pycheck_1000_100byte_tags % cpu utilization -1.26 [-5.85, +3.32]

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

@L3n41c L3n41c force-pushed the lenaic/docker_images_std_labels branch from bb1560e to c1ede76 Compare May 31, 2024 04:45
@L3n41c L3n41c force-pushed the lenaic/docker_images_std_labels branch from c1ede76 to 6e9e4a5 Compare May 31, 2024 07:56
@L3n41c
Copy link
Member Author

L3n41c commented May 31, 2024

/merge

@dd-devflow
Copy link

dd-devflow bot commented May 31, 2024

🚂 MergeQueue

Pull request added to the queue.

This build is next! (estimated merge in less than 54m)

Use /merge -c to cancel this operation!

@dd-mergequeue dd-mergequeue bot merged commit 2062618 into main May 31, 2024
@dd-mergequeue dd-mergequeue bot deleted the lenaic/docker_images_std_labels branch May 31, 2024 10:26
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.

3 participants