datadog-agent icon indicating copy to clipboard operation
datadog-agent copied to clipboard

Make tabulate import error explicit

Open usamasaqib opened this issue 1 year ago • 3 comments

What does this PR do?

The ebpf invoke tasks use the tabulate package to pretty print its results. This task is not intended to run in the CI. We use a try..except block to prevent packages not used in the CI from failing the jobs. However, when these are not installed in the user machine, they can lead to confusing errors. This PR addresses this by making import errors more explicit to the user.

Motivation

Additional Notes

Possible Drawbacks / Trade-offs

Describe how to test/QA your changes

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.

usamasaqib avatar Feb 14 '24 08:02 usamasaqib

Maybe we can create a separate requirements file for the CI and add the tabulate package to requirements.txt?

We do not want to add packages not used in the CI to the requirements.txt file, in order to not add unnecessary dependencies in the docker images.

usamasaqib avatar Feb 14 '24 09:02 usamasaqib

Maybe we can create a separate requirements file for the CI and add the tabulate package to requirements.txt?

We do not want to add packages not used in the CI to the requirements.txt file, in order to not add unnecessary dependencies in the docker images.

Yes, that's why I proposed to have a separate (more slim) requirements-CI.txt to use in the CI, and a full requirements.txt with all packages required in the inv tasks

val06 avatar Feb 14 '24 09:02 val06

Bloop Bleep... Dogbot Here

Regression Detector Results

Run ID: 7d55267a-866d-4a78-a180-900e27f00c54 Baseline: 1da1d7f12a264315731a482eed338af367d8628b Comparison: 6877f3485d7d4fb08073f95051542834791d2d5d 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
file_to_blackhole % cpu utilization +0.08 [-6.48, +6.65]

Fine details of change detection per experiment

perf experiment goal Δ mean % Δ mean % CI
file_tree memory utilization +0.20 [+0.07, +0.32]
tcp_syslog_to_blackhole ingress throughput +0.19 [+0.14, +0.24]
process_agent_standard_check_with_stats memory utilization +0.09 [+0.05, +0.12]
file_to_blackhole % cpu utilization +0.08 [-6.48, +6.65]
tcp_dd_logs_filter_exclude ingress throughput +0.00 [-0.00, +0.00]
uds_dogstatsd_to_api ingress throughput +0.00 [-0.00, +0.00]
trace_agent_msgpack ingress throughput -0.01 [-0.02, -0.00]
trace_agent_json ingress throughput -0.03 [-0.06, -0.00]
process_agent_standard_check memory utilization -0.12 [-0.17, -0.08]
process_agent_real_time_mode memory utilization -0.27 [-0.30, -0.24]
idle memory utilization -0.57 [-0.62, -0.52]
otel_to_otel_logs ingress throughput -0.72 [-1.33, -0.10]
uds_dogstatsd_to_api_cpu % cpu utilization -0.88 [-2.31, +0.55]

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

pr-commenter[bot] avatar Feb 14 '24 09:02 pr-commenter[bot]