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

[CONTP-512] Add settings on sidecar to terminate on finished job #31543

Merged
merged 4 commits into from
Dec 3, 2024

Conversation

gabedos
Copy link
Contributor

@gabedos gabedos commented Nov 27, 2024

What does this PR do?

Terminates the agent when running as a sidecar when there are no other processes left running in the job.

Motivation

Support case with customer having a non-terminating sidecar agent that would cause the job to never be completed.

Describe how to test/QA your changes

Deploy the cluster agent with the sidecar injection enabled

datadog:
  kubelet:
    tlsVerify: false
agents:
  enabled: false
clusterAgent:
  image:
    tag: <INSERT_RC_TAG>
    pullPolicy: Always
  enabled: true
  replicas: 1
  admissionController:
    agentSidecarInjection:
      enabled: true
      provider: fargate

Deploy a dummy job that allows the agent sidecar to be injected via k apply -f sidecar-job.yaml

apiVersion: batch/v1
kind: Job
metadata:
  name: pi
spec:
  template:
    spec:
      containers:
        - name: pi
          image: perl:5.34.0
          command: ["perl", "-Mbignum=bpi", "-wle", "print bpi(2000)"]
      restartPolicy: Never
    metadata:
      labels:
        agent.datadoghq.com/sidecar: fargate
  backoffLimit: 4

Note: make sure you have a datadog-secret with an api-key and app-key defined wherever you deploy the job. Otherwise run the following

kubectl create secret generic datadog-secret -n <INSERT_NAMESPACE> \
        --from-literal api-key=$DD_API_KEY --from-literal token=random32characterstringfortoken1

You should expect for a pod to be deployed with 2 containers, one being the pi container and the other being the agent container. After about 15 seconds you should see only 1/2 containers are running as the pi calculation terminates. After about 60 seconds you should 0/2 Completed for the pi pod.

Possible Drawbacks / Trade-offs

N/A

Additional Notes

Also works for cronJobs

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

agent-platform-auto-pr bot commented Nov 27, 2024

[Fast Unit Tests Report]

On pipeline 50273068 (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

@agent-platform-auto-pr
Copy link
Contributor

agent-platform-auto-pr bot commented Nov 27, 2024

Test changes on VM

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

inv create-vm --pipeline-id=50273068 --os-family=ubuntu

Note: This applies to commit 0d009c8

Copy link

cit-pr-commenter bot commented Nov 27, 2024

Regression Detector

Regression Detector Results

Metrics dashboard
Target profiles
Run ID: ad4c9583-8558-4695-a407-937535e5a0d5

Baseline: a480276
Comparison: 0d009c8
Diff

Optimization Goals: ✅ No significant changes detected

Fine details of change detection per experiment

perf experiment goal Δ mean % Δ mean % CI trials links
otel_to_otel_logs ingress throughput +1.08 [+0.40, +1.75] 1 Logs
quality_gate_idle_all_features memory utilization +1.05 [+0.88, +1.21] 1 Logs bounds checks dashboard
file_tree memory utilization +0.24 [+0.09, +0.39] 1 Logs
file_to_blackhole_1000ms_latency_linear_load egress throughput +0.17 [-0.29, +0.64] 1 Logs
file_to_blackhole_300ms_latency egress throughput +0.02 [-0.61, +0.64] 1 Logs
tcp_dd_logs_filter_exclude ingress throughput -0.00 [-0.01, +0.01] 1 Logs
file_to_blackhole_100ms_latency egress throughput -0.01 [-0.72, +0.70] 1 Logs
uds_dogstatsd_to_api ingress throughput -0.01 [-0.13, +0.10] 1 Logs
file_to_blackhole_0ms_latency egress throughput -0.03 [-0.87, +0.81] 1 Logs
quality_gate_idle memory utilization -0.07 [-0.14, +0.00] 1 Logs bounds checks dashboard
file_to_blackhole_500ms_latency egress throughput -0.13 [-0.90, +0.65] 1 Logs
file_to_blackhole_1000ms_latency egress throughput -0.37 [-1.16, +0.42] 1 Logs
quality_gate_logs % cpu utilization -0.54 [-3.54, +2.45] 1 Logs
tcp_syslog_to_blackhole ingress throughput -0.92 [-0.98, -0.85] 1 Logs
uds_dogstatsd_to_api_cpu % cpu utilization -1.11 [-1.84, -0.38] 1 Logs
pycheck_lots_of_tags % cpu utilization -2.19 [-5.72, +1.34] 1 Logs
basic_py_check % cpu utilization -2.48 [-6.19, +1.22] 1 Logs

Bounds Checks: ❌ Failed

perf experiment bounds_check_name replicates_passed links
quality_gate_idle memory_usage 9/10 bounds checks dashboard
file_to_blackhole_0ms_latency lost_bytes 10/10
file_to_blackhole_0ms_latency 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_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

Failed. Some Quality Gates were violated.

  • quality_gate_idle_all_features, bounds check memory_usage: 10/10 replicas passed. Gate passed.
  • quality_gate_idle, bounds check memory_usage: 9/10 replicas passed. Failed 1 which is > 0. Gate FAILED.
  • 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.

@gabedos gabedos added the qa/rc-required Only for a PR that requires validation on the Release Candidate label Dec 2, 2024
@gabedos gabedos changed the title Add settings on sidecar to terminate on finished job [CONTP-512] Add settings on sidecar to terminate on finished job Dec 2, 2024
@gabedos gabedos force-pushed the gabedos/kill-sidecar-on-jobs branch from bdb7db0 to 5f7d739 Compare December 2, 2024 15:30
@gabedos gabedos marked this pull request as ready for review December 2, 2024 18:48
@gabedos gabedos requested review from a team as code owners December 2, 2024 18:48
@gabedos gabedos added this to the 7.62.0 milestone Dec 2, 2024
@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 Dec 3, 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.

small nits,
otherwise looks good 👏

@gabedos
Copy link
Contributor Author

gabedos commented Dec 3, 2024

/merge

@dd-devflow
Copy link

dd-devflow bot commented Dec 3, 2024

Devflow running: /merge

View all feedbacks in Devflow UI.


2024-12-03 19:03:22 UTC ℹ️ MergeQueue: pull request added to the queue

The median merge time in main is 23m.

@dd-mergequeue dd-mergequeue bot merged commit daeb6ba into main Dec 3, 2024
227 checks passed
@dd-mergequeue dd-mergequeue bot deleted the gabedos/kill-sidecar-on-jobs branch December 3, 2024 19:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
medium review PR review might take time qa/rc-required Only for a PR that requires validation on the Release Candidate team/container-platform The Container Platform Team
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants