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

autoinstrumentation: apm injector volume is RW #32828

Merged
merged 2 commits into from
Jan 10, 2025

Conversation

stanistan
Copy link
Member

What does this PR do?

When adding the inject volume into application containers, no longer set it as ReadOnly.

It is useful to have it RW in case we want to have temporary files there (scoped to the lifecycle of the pod) that the injector can use for container-level metadata.

For example:

  • sending container-level telemetry once instead of once per process.

Motivation

APM injection sends back some telemetry about process/language data and we want to make sure that we do so less frequently. For example, if we're measuring pod start time from the container -- really container start time, we want to store some metadata in a deterministic place but we don't have a guarantee that /tmp exists and is writeable

Describe how you validated your changes

Change is covered by a change in unit tests.

Possible Drawbacks / Trade-offs

N/A

Additional Notes

N/A

@stanistan stanistan requested review from a team as code owners January 9, 2025 18:44
@github-actions github-actions bot added team/container-platform The Container Platform Team team/injection-platform short review PR is simple enough to be reviewed quickly labels Jan 9, 2025
@agent-platform-auto-pr
Copy link
Contributor

agent-platform-auto-pr bot commented Jan 9, 2025

[Fast Unit Tests Report]

On pipeline 52685797 (CI Visibility). The following jobs did not run any unit tests:

Jobs:
  • tests_flavor_dogstatsd_deb-x64
  • tests_flavor_heroku_deb-x64
  • tests_flavor_iot_deb-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-devx-help

Copy link

cit-pr-commenter bot commented Jan 9, 2025

Regression Detector

Regression Detector Results

Metrics dashboard
Target profiles
Run ID: 216de561-311e-450e-b1d5-d4353cd1555c

Baseline: b27fd01
Comparison: 54603bd
Diff

Optimization Goals: ✅ No significant changes detected

Fine details of change detection per experiment

perf experiment goal Δ mean % Δ mean % CI trials links
uds_dogstatsd_to_api_cpu % cpu utilization +1.18 [+0.50, +1.86] 1 Logs
tcp_syslog_to_blackhole ingress throughput +1.07 [+1.02, +1.13] 1 Logs
file_tree memory utilization +0.49 [+0.35, +0.62] 1 Logs
quality_gate_idle_all_features memory utilization +0.36 [+0.27, +0.45] 1 Logs bounds checks dashboard
file_to_blackhole_1000ms_latency egress throughput +0.25 [-0.54, +1.04] 1 Logs
file_to_blackhole_0ms_latency_http1 egress throughput +0.06 [-0.81, +0.93] 1 Logs
file_to_blackhole_500ms_latency egress throughput +0.06 [-0.73, +0.84] 1 Logs
quality_gate_idle memory utilization +0.05 [+0.02, +0.09] 1 Logs bounds checks dashboard
file_to_blackhole_0ms_latency_http2 egress throughput +0.02 [-0.82, +0.85] 1 Logs
tcp_dd_logs_filter_exclude ingress throughput -0.00 [-0.01, +0.01] 1 Logs
uds_dogstatsd_to_api ingress throughput -0.00 [-0.12, +0.11] 1 Logs
file_to_blackhole_0ms_latency egress throughput -0.01 [-0.89, +0.88] 1 Logs
file_to_blackhole_100ms_latency egress throughput -0.01 [-0.70, +0.68] 1 Logs
file_to_blackhole_300ms_latency egress throughput -0.03 [-0.66, +0.61] 1 Logs
file_to_blackhole_1000ms_latency_linear_load egress throughput -0.17 [-0.63, +0.29] 1 Logs
quality_gate_logs % cpu utilization -1.91 [-5.12, +1.30] 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 memory_usage 10/10 bounds checks dashboard
quality_gate_idle_all_features memory_usage 10/10 bounds checks dashboard
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, bounds check memory_usage: 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 lost_bytes: 10/10 replicas passed. Gate passed.
  • quality_gate_logs, bounds check memory_usage: 10/10 replicas passed. Gate passed.

@stanistan stanistan added changelog/no-changelog qa/done QA done before merge and regressions are covered by tests labels Jan 9, 2025
Copy link
Contributor

@adel121 adel121 left a comment

Choose a reason for hiding this comment

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

LGTM 👍

@agent-platform-auto-pr
Copy link
Contributor

agent-platform-auto-pr bot commented Jan 10, 2025

Uncompressed package size comparison

Comparison with ancestor b27fd01c3bb55bdc2a7b6f2f06716deea95946e7

Diff per package
package diff status size ancestor threshold
datadog-agent-amd64-deb 0.00MB 1009.51MB 1009.51MB 0.50MB
datadog-agent-x86_64-rpm 0.00MB 1018.83MB 1018.83MB 0.50MB
datadog-agent-x86_64-suse 0.00MB 1018.83MB 1018.83MB 0.50MB
datadog-agent-arm64-deb 0.00MB 939.28MB 939.28MB 0.50MB
datadog-agent-aarch64-rpm 0.00MB 948.58MB 948.58MB 0.50MB
datadog-dogstatsd-amd64-deb 0.00MB 58.83MB 58.83MB 0.50MB
datadog-dogstatsd-x86_64-rpm 0.00MB 58.90MB 58.90MB 0.50MB
datadog-dogstatsd-x86_64-suse 0.00MB 58.90MB 58.90MB 0.50MB
datadog-dogstatsd-arm64-deb 0.00MB 56.33MB 56.33MB 0.50MB
datadog-heroku-agent-amd64-deb 0.00MB 506.82MB 506.82MB 0.50MB
datadog-iot-agent-amd64-deb 0.00MB 114.20MB 114.20MB 0.50MB
datadog-iot-agent-x86_64-rpm 0.00MB 114.27MB 114.27MB 0.50MB
datadog-iot-agent-x86_64-suse 0.00MB 114.27MB 114.27MB 0.50MB
datadog-iot-agent-arm64-deb 0.00MB 109.62MB 109.62MB 0.50MB
datadog-iot-agent-aarch64-rpm 0.00MB 109.69MB 109.69MB 0.50MB

Decision

✅ Passed

@agent-platform-auto-pr
Copy link
Contributor

agent-platform-auto-pr bot commented Jan 10, 2025

Test changes on VM

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

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

Note: This applies to commit 54603bd

When adding the inject volume into application containers,
no longer set it as ReadOnly.

It is useful to have it RW in case we want to have temporary files
there (scoped to the lifecycle of the pod) that the injector can use
for container-level metadata.

For example:
- sending container-level telemetry once instead of once per
  process.
@stanistan stanistan force-pushed the stanistan/injector-rw-volume branch from a8775cb to 54603bd Compare January 10, 2025 16:06
@@ -140,7 +140,7 @@ func (v volumeMount) mutateContainer(c *corev1.Container) error {
return nil
}

func (v volumeMount) readOnly() volumeMount {
func (v volumeMount) readOnly() volumeMount { // nolint:unused
Copy link
Member

Choose a reason for hiding this comment

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

Why not remove this?

Copy link
Member Author

Choose a reason for hiding this comment

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

My thought on the mutators is that they should probably be in a different package and this should be part of the public interface so I'm keeping it that way as this is a pretend-future-library.

@github-actions github-actions bot added medium review PR review might take time and removed short review PR is simple enough to be reviewed quickly labels Jan 10, 2025
@stanistan
Copy link
Member Author

/merge

@dd-devflow
Copy link

dd-devflow bot commented Jan 10, 2025

Devflow running: /merge

View all feedbacks in Devflow UI.


2025-01-10 18:13:41 UTC ℹ️ MergeQueue: pull request added to the queue

The median merge time in main is 35m.


2025-01-10 18:48:51 UTC ℹ️ MergeQueue: This merge request was merged

@dd-mergequeue dd-mergequeue bot merged commit 17111e2 into main Jan 10, 2025
234 checks passed
@dd-mergequeue dd-mergequeue bot deleted the stanistan/injector-rw-volume branch January 10, 2025 18:48
@github-actions github-actions bot added this to the 7.63.0 milestone Jan 10, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
changelog/no-changelog medium review PR review might take time qa/done QA done before merge and regressions are covered by tests team/container-platform The Container Platform Team team/injection-platform
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants