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

[cri-o] Stop querying image status endpoint when image metadata collection is disabled #35112

Open
wants to merge 5 commits into
base: main
Choose a base branch
from

Conversation

sblumenthal
Copy link
Member

@sblumenthal sblumenthal commented Mar 13, 2025

What does this PR do?

Updates the CRI-O workloadmeta collector to only query the ImageStatus endpoint if container_image.enabled is true

Motivation

Currently, the ImageStatus endpoint exposed by the CRI-O server logs every time a connection is made to it. This causes the journald logs to slowly increase in size, until eventually the node has too much disk pressure and becomes unschedulable.

We should only be using this endpoint to collect information about the image layers themselves, for the purposes of image metadata collection. However, when image metadata collection was disabled, this endpoint was still being queried to fetch the image repo digest and repo tag, both of which are exposed in the container status.

Describe how you validated your changes

Deploy the agent in cri-o via helm (I did so using minikube), with container image collection disabled:

datadog:
  sbom:
    containerImage:
      enabled: false
  containerImageCollection:
    enabled: false
  env:
    - name: DD_CONTAINER_IMAGE_ENABLED
      value: "false"

Validate that there are no container_image_metadata entries in the output of agent workload-list -v

Validate that there are no log entries related to ImageStatus in the output of sudo journalctl -xe on the minikube node (or, that, over time the overall size of /run/log/journal/ is not dramatically increasing)

I have already done all of the above, as well as deployed the agent with and without this change to validate the workloadmeta objects match:

Before:

=== Entity container source:runtime id: 0ddf2d187d10a149b740a67483779709734b3747c8a8e8ab94cbe57bcca5ed2d ===
----------- Entity ID -----------
Kind: container ID: 0ddf2d187d10a149b740a67483779709734b3747c8a8e8ab94cbe57bcca5ed2d
----------- Entity Meta -----------
Name: kube-apiserver
Namespace: kube-system
Annotations: io.kubernetes.container.terminationMessagePolicy:File io.kubernetes.pod.terminationGracePeriod:30 io.kubernetes.container.hash:bf915d6a io.kubernetes.container.restartCount:0 io.kubernetes.container.terminationMessagePath:/dev/termination-log
Labels: io.kubernetes.container.name:kube-apiserver io.kubernetes.pod.name:kube-apiserver-crio-test io.kubernetes.pod.namespace:kube-system io.kubernetes.pod.uid:***************************5dc9d
----------- Image -----------
Name: registry.k8s.io/kube-apiserver
Tag: v1.32.0
ID: sha256:9ff42b586c0a57f3fc4a0689afe6db4d8f92f7f79bef3b47b2c75ab112e17de7
Raw Name: registry.k8s.io/kube-apiserver:v1.32.0
Short Name: kube-apiserver
Repo Digest: registry.k8s.io/kube-apiserver@sha256:9ff42b586c0a57f3fc4a0689afe6db4d8f92f7f79bef3b47b2c75ab112e17de7
----------- Container Info -----------
Runtime: cri-o
RuntimeFlavor:
Running: true
Status: running
Health:
Created At: 2025-03-14 02:32:25.538779129 +0000 UTC
Started At: 2025-03-14 02:32:25.592735837 +0000 UTC
Finished At: 1970-01-01 00:00:00 +0000 UTC
Exit Code: 0
----------- Resources -----------
----------- Allocated Resources -----------
Hostname: crio-test
Network IPs:
PID: 1352
Cgroup path: /crio/crio-0ddf2d187d10a149b740a67483779709734b3747c8a8e8ab94cbe57bcca5ed2d
===

After:

=== Entity container source:runtime id: af0ccb585d5380add5de2917546c84bbc0c6f0fbddfa5401e6f51c7ab4ba17f7 ===
----------- Entity ID -----------
Kind: container ID: af0ccb585d5380add5de2917546c84bbc0c6f0fbddfa5401e6f51c7ab4ba17f7
----------- Entity Meta -----------
Name: kube-apiserver
Namespace: kube-system
Annotations: io.kubernetes.container.restartCount:1 io.kubernetes.container.terminationMessagePath:/dev/termination-log io.kubernetes.container.terminationMessagePolicy:File io.kubernetes.pod.terminationGracePeriod:30 io.kubernetes.container.hash:bf915d6a
Labels: io.kubernetes.pod.name:kube-apiserver-crio-test io.kubernetes.pod.namespace:kube-system io.kubernetes.pod.uid:***************************5dc9d io.kubernetes.container.name:kube-apiserver
----------- Image -----------
Name: registry.k8s.io/kube-apiserver
Tag: v1.32.0
ID: sha256:9ff42b586c0a57f3fc4a0689afe6db4d8f92f7f79bef3b47b2c75ab112e17de7
Raw Name: registry.k8s.io/kube-apiserver:v1.32.0
Short Name: kube-apiserver
Repo Digest: registry.k8s.io/kube-apiserver@sha256:9ff42b586c0a57f3fc4a0689afe6db4d8f92f7f79bef3b47b2c75ab112e17de7
----------- Container Info -----------
Runtime: cri-o
RuntimeFlavor:
Running: true
Status: running
Health:
Created At: 2025-03-14 13:46:16.420925471 +0000 UTC
Started At: 2025-03-14 13:46:16.440709596 +0000 UTC
Finished At: 1970-01-01 00:00:00 +0000 UTC
Exit Code: 0
----------- Resources -----------
----------- Allocated Resources -----------
Hostname: crio-test
Network IPs:
PID: 889
Cgroup path: /crio/crio-af0ccb585d5380add5de2917546c84bbc0c6f0fbddfa5401e6f51c7ab4ba17f7
===

(ignore differences in Cgroup path and container IDs, I had to restart the cluster)

Possible Drawbacks / Trade-offs

Additional Notes

@github-actions github-actions bot added team/container-platform The Container Platform Team short review PR is simple enough to be reviewed quickly labels Mar 13, 2025
@agent-platform-auto-pr
Copy link
Contributor

agent-platform-auto-pr bot commented Mar 13, 2025

Uncompressed package size comparison

Comparison with ancestor 58383beed22bd4e66362471500f1f5410c2f635e

Size reduction summary
package diff status size ancestor threshold
datadog-agent-amd64-deb -0.01MB 810.24MB 810.25MB 0.50MB
datadog-agent-x86_64-rpm -0.01MB 820.04MB 820.05MB 0.50MB
datadog-agent-x86_64-suse -0.01MB 820.04MB 820.05MB 0.50MB
Diff per package
package diff status size ancestor threshold
datadog-agent-arm64-deb 0.00MB 801.20MB 801.20MB 0.50MB
datadog-agent-aarch64-rpm 0.00MB 810.98MB 810.98MB 0.50MB
datadog-dogstatsd-amd64-deb 0.00MB 39.33MB 39.33MB 0.50MB
datadog-dogstatsd-x86_64-rpm 0.00MB 39.41MB 39.41MB 0.50MB
datadog-dogstatsd-x86_64-suse 0.00MB 39.41MB 39.41MB 0.50MB
datadog-dogstatsd-arm64-deb 0.00MB 37.86MB 37.86MB 0.50MB
datadog-heroku-agent-amd64-deb 0.00MB 441.25MB 441.25MB 0.50MB
datadog-iot-agent-amd64-deb 0.00MB 62.18MB 62.18MB 0.50MB
datadog-iot-agent-x86_64-rpm 0.00MB 62.25MB 62.25MB 0.50MB
datadog-iot-agent-x86_64-suse 0.00MB 62.25MB 62.25MB 0.50MB
datadog-iot-agent-arm64-deb 0.00MB 59.41MB 59.41MB 0.50MB
datadog-iot-agent-aarch64-rpm 0.00MB 59.48MB 59.48MB 0.50MB

Decision

✅ Passed

@agent-platform-auto-pr
Copy link
Contributor

agent-platform-auto-pr bot commented Mar 13, 2025

Test changes on VM

Use this command from test-infra-definitions to manually test this PR changes on a VM:

dda inv aws.create-vm --pipeline-id=58895388 --os-family=ubuntu

Note: This applies to commit 88b6169

@agent-platform-auto-pr
Copy link
Contributor

agent-platform-auto-pr bot commented Mar 13, 2025

Static quality checks ✅

Please find below the results from static quality gates

Successful checks

Info

Result Quality gate On disk size On disk size limit On wire size On wire size limit
static_quality_gate_agent_deb_amd64 784.16 MiB 801.8 MiB 191.02 MiB 202.62 MiB
static_quality_gate_agent_deb_arm64 775.55 MiB 793.14 MiB 173.24 MiB 184.51 MiB
static_quality_gate_agent_rpm_amd64 784.13 MiB 801.79 MiB 193.15 MiB 205.03 MiB
static_quality_gate_agent_rpm_arm64 775.58 MiB 793.09 MiB 175.46 MiB 186.44 MiB
static_quality_gate_agent_suse_amd64 784.13 MiB 801.81 MiB 193.15 MiB 205.03 MiB
static_quality_gate_agent_suse_arm64 775.55 MiB 793.14 MiB 175.46 MiB 186.44 MiB
static_quality_gate_dogstatsd_deb_amd64 37.59 MiB 47.67 MiB 9.74 MiB 19.78 MiB
static_quality_gate_dogstatsd_deb_arm64 36.18 MiB 46.27 MiB 8.45 MiB 18.49 MiB
static_quality_gate_dogstatsd_rpm_amd64 37.59 MiB 47.67 MiB 9.75 MiB 19.79 MiB
static_quality_gate_dogstatsd_suse_amd64 37.59 MiB 47.67 MiB 9.75 MiB 19.79 MiB
static_quality_gate_iot_agent_deb_amd64 59.38 MiB 69.0 MiB 14.92 MiB 24.8 MiB
static_quality_gate_iot_agent_deb_arm64 56.73 MiB 66.4 MiB 12.85 MiB 22.8 MiB
static_quality_gate_iot_agent_rpm_amd64 59.38 MiB 69.0 MiB 14.94 MiB 24.8 MiB
static_quality_gate_iot_agent_rpm_arm64 56.73 MiB 66.4 MiB 12.88 MiB 22.8 MiB
static_quality_gate_iot_agent_suse_amd64 59.38 MiB 69.0 MiB 14.94 MiB 24.8 MiB
static_quality_gate_docker_agent_amd64 868.86 MiB 886.12 MiB 292.19 MiB 304.21 MiB
static_quality_gate_docker_agent_arm64 883.5 MiB 900.79 MiB 278.54 MiB 290.47 MiB
static_quality_gate_docker_agent_jmx_amd64 1.04 GiB 1.06 GiB 367.28 MiB 379.33 MiB
static_quality_gate_docker_agent_jmx_arm64 1.05 GiB 1.06 GiB 349.62 MiB 361.55 MiB
static_quality_gate_docker_dogstatsd_amd64 45.73 MiB 55.78 MiB 17.25 MiB 27.28 MiB
static_quality_gate_docker_dogstatsd_arm64 44.36 MiB 54.45 MiB 16.12 MiB 26.16 MiB
static_quality_gate_docker_cluster_agent_amd64 264.87 MiB 274.78 MiB 106.29 MiB 116.28 MiB
static_quality_gate_docker_cluster_agent_arm64 280.82 MiB 290.82 MiB 101.13 MiB 111.12 MiB

Copy link

cit-pr-commenter bot commented Mar 14, 2025

Regression Detector

Regression Detector Results

Metrics dashboard
Target profiles
Run ID: 37c719fc-e242-4550-85bb-aaf45e04770b

Baseline: 58383be
Comparison: 88b6169
Diff

Optimization Goals: ✅ No significant changes detected

Fine details of change detection per experiment

perf experiment goal Δ mean % Δ mean % CI trials links
quality_gate_logs % cpu utilization +2.92 [+0.01, +5.83] 1 Logs
file_tree memory utilization +0.48 [+0.29, +0.67] 1 Logs
uds_dogstatsd_to_api_cpu % cpu utilization +0.36 [-0.49, +1.21] 1 Logs
quality_gate_idle_all_features memory utilization +0.33 [+0.25, +0.42] 1 Logs bounds checks dashboard
file_to_blackhole_300ms_latency egress throughput +0.03 [-0.59, +0.66] 1 Logs
file_to_blackhole_0ms_latency_http1 egress throughput +0.00 [-0.79, +0.80] 1 Logs
tcp_dd_logs_filter_exclude ingress throughput -0.00 [-0.02, +0.02] 1 Logs
file_to_blackhole_100ms_latency egress throughput -0.00 [-0.66, +0.65] 1 Logs
file_to_blackhole_0ms_latency egress throughput -0.01 [-0.87, +0.85] 1 Logs
uds_dogstatsd_to_api ingress throughput -0.01 [-0.34, +0.32] 1 Logs
file_to_blackhole_500ms_latency egress throughput -0.02 [-0.80, +0.77] 1 Logs
file_to_blackhole_0ms_latency_http2 egress throughput -0.05 [-0.86, +0.76] 1 Logs
file_to_blackhole_1000ms_latency_linear_load egress throughput -0.21 [-0.67, +0.26] 1 Logs
uds_dogstatsd_20mb_12k_contexts_20_senders memory utilization -0.31 [-0.35, -0.26] 1 Logs
file_to_blackhole_1000ms_latency egress throughput -0.37 [-1.15, +0.40] 1 Logs
quality_gate_idle memory utilization -0.39 [-0.46, -0.31] 1 Logs bounds checks dashboard
tcp_syslog_to_blackhole ingress throughput -0.90 [-0.97, -0.84] 1 Logs

Bounds Checks: ✅ Passed

perf experiment bounds_check_name replicates_passed links
file_to_blackhole_0ms_latency lost_bytes 10/10
file_to_blackhole_0ms_latency memory_usage 10/10
file_to_blackhole_0ms_latency_http1 lost_bytes 10/10
file_to_blackhole_0ms_latency_http1 memory_usage 10/10
file_to_blackhole_0ms_latency_http2 lost_bytes 10/10
file_to_blackhole_0ms_latency_http2 memory_usage 10/10
file_to_blackhole_1000ms_latency memory_usage 10/10
file_to_blackhole_1000ms_latency_linear_load memory_usage 10/10
file_to_blackhole_100ms_latency lost_bytes 10/10
file_to_blackhole_100ms_latency memory_usage 10/10
file_to_blackhole_300ms_latency lost_bytes 10/10
file_to_blackhole_300ms_latency memory_usage 10/10
file_to_blackhole_500ms_latency lost_bytes 10/10
file_to_blackhole_500ms_latency memory_usage 10/10
quality_gate_idle intake_connections 10/10 bounds checks dashboard
quality_gate_idle memory_usage 10/10 bounds checks dashboard
quality_gate_idle_all_features intake_connections 10/10 bounds checks dashboard
quality_gate_idle_all_features memory_usage 10/10 bounds checks dashboard
quality_gate_logs intake_connections 10/10
quality_gate_logs lost_bytes 10/10
quality_gate_logs memory_usage 10/10

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

CI Pass/Fail Decision

Passed. All Quality Gates passed.

  • quality_gate_idle_all_features, bounds check intake_connections: 10/10 replicas passed. Gate passed.
  • quality_gate_idle_all_features, bounds check memory_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 lost_bytes: 10/10 replicas passed. Gate passed.
  • quality_gate_logs, bounds check intake_connections: 10/10 replicas passed. Gate passed.
  • quality_gate_idle, bounds check intake_connections: 10/10 replicas passed. Gate passed.
  • quality_gate_idle, bounds check memory_usage: 10/10 replicas passed. Gate passed.

@sblumenthal sblumenthal added team/containers qa/done QA done before merge and regressions are covered by tests and removed team/container-platform The Container Platform Team labels Mar 14, 2025
@sblumenthal sblumenthal marked this pull request as ready for review March 14, 2025 16:42
@sblumenthal sblumenthal requested review from a team as code owners March 14, 2025 16:42
@sblumenthal sblumenthal added this to the 7.65.0 milestone Mar 14, 2025
@janine-c janine-c self-assigned this Mar 14, 2025
Copy link
Contributor

@janine-c janine-c left a comment

Choose a reason for hiding this comment

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

Looks great! Just a couple of very minor suggestions for the release note 🙂

@sblumenthal
Copy link
Member Author

/merge

@dd-devflow
Copy link

dd-devflow bot commented Mar 14, 2025

View all feedbacks in Devflow UI.
2025-03-14 19:03:52 UTC ℹ️ Start processing command /merge
Use /merge -c to cancel this operation!


2025-03-14 19:03:58 UTC ℹ️ MergeQueue: waiting for PR to be ready

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!


2025-03-14 20:20:09 UTC ℹ️ MergeQueue: merge request added to the queue

The expected merge time in main is approximately 42m (p90).

Use /merge -c to cancel this operation!


⏳ Processing ...

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
qa/done QA done before merge and regressions are covered by tests short review PR is simple enough to be reviewed quickly team/containers
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants