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

[otel-agent] report and build with proper versioning #29334

Merged
merged 4 commits into from
Oct 1, 2024

Conversation

truthbk
Copy link
Member

@truthbk truthbk commented Sep 13, 2024

What does this PR do?

This PR attempts to introduce proper versioning for the otel-agent. The goal is that otel-agent and agent are aligned with the respective pkg/version versioning pattern. We also still need to understand what OTel Collector version is being used (currently reported in BuildInfo as v0.104.0) and submitted in the metadata as the extension version).

Motivation

Proper version tracking for the otel-agent and the OTel Collector internals moving forward.

Additional Notes

We may want to add additional fields to the OTel metadata payload. We may need to discern between:

  • otel-agent version
  • extension version
  • collector component version

Possible Drawbacks / Trade-offs

Describe how to test/QA your changes

  • OTel metadata payloads in the app should reflect the updated versioning.
  • otel-agent version and agent version commands should reflect the same version.

@truthbk truthbk requested review from a team as code owners September 13, 2024 12:04
@truthbk truthbk changed the title [otel-agent] [otel-agent] report and build with proper versioning Sep 13, 2024
@github-actions github-actions bot added the team/opentelemetry OpenTelemetry team label Sep 13, 2024
cmd/otel-agent/main.go Show resolved Hide resolved
@@ -69,6 +69,7 @@ require (
github.com/DataDog/datadog-agent/comp/otelcol/configstore/def v0.56.0-rc.3
github.com/DataDog/datadog-agent/comp/otelcol/configstore/impl v0.56.0-rc.3
github.com/DataDog/datadog-agent/comp/otelcol/ddflareextension/def v0.0.0-00010101000000-000000000000
github.com/DataDog/datadog-agent/pkg/version v0.0.0-00010101000000-000000000000
Copy link
Contributor

Choose a reason for hiding this comment

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

we import v0.57.0 here and here; does it make sense to make this consistent across the repo?

Suggested change
github.com/DataDog/datadog-agent/pkg/version v0.0.0-00010101000000-000000000000
github.com/DataDog/datadog-agent/pkg/version v0.57.0

Copy link
Contributor

Choose a reason for hiding this comment

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

recommend adding the replace for

github.com/DataDog/datadog-agent/pkg/version => ../../../../../pkg/version

on line 36

Copy link
Member Author

Choose a reason for hiding this comment

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

Agreed. Yup.

@pr-commenter
Copy link

pr-commenter bot commented Sep 24, 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=45302381 --os-family=ubuntu

Note: This applies to commit e51aece

@pr-commenter
Copy link

pr-commenter bot commented Sep 24, 2024

Regression Detector

Regression Detector Results

Run ID: 1f5ecf6a-4223-4d35-bf3e-1267a55434cd Metrics dashboard Target profiles

Baseline: 2588d20
Comparison: e51aece

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 trials links
idle_all_features memory utilization +0.99 [+0.91, +1.06] 1 Logs
pycheck_lots_of_tags % cpu utilization +0.72 [-1.87, +3.31] 1 Logs
basic_py_check % cpu utilization +0.52 [-2.21, +3.25] 1 Logs
uds_dogstatsd_to_api_cpu % cpu utilization +0.28 [-0.45, +1.02] 1 Logs
idle memory utilization +0.19 [+0.15, +0.23] 1 Logs
otel_to_otel_logs ingress throughput +0.06 [-0.75, +0.86] 1 Logs
tcp_dd_logs_filter_exclude ingress throughput +0.00 [-0.01, +0.01] 1 Logs
uds_dogstatsd_to_api ingress throughput -0.02 [-0.11, +0.06] 1 Logs
tcp_syslog_to_blackhole ingress throughput -0.06 [-0.11, -0.01] 1 Logs
file_tree memory utilization -0.22 [-0.31, -0.13] 1 Logs

Bounds Checks

perf experiment bounds_check_name replicates_passed
idle memory_usage 10/10

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

@jackgopack4
Copy link
Contributor

another thought: for BYOC, this requires users to set a distribution version number, right? Will it cause issues if they either don't specify a distribution version number or have a number different than the underlying components?

Copy link
Member

@amenasria amenasria left a comment

Choose a reason for hiding this comment

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

LGTM for Agent DevX Infra owned file !

@truthbk
Copy link
Member Author

truthbk commented Oct 1, 2024

/merge

@dd-devflow
Copy link

dd-devflow bot commented Oct 1, 2024

🚂 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!

@truthbk truthbk added this to the 7.58.0 milestone Oct 1, 2024
@dd-devflow
Copy link

dd-devflow bot commented Oct 1, 2024

🚂 MergeQueue: pull request added to the queue

The median merge time in main is 27m.

Use /merge -c to cancel this operation!

@dd-mergequeue dd-mergequeue bot merged commit bfbb0bc into main Oct 1, 2024
240 of 241 checks passed
@dd-mergequeue dd-mergequeue bot deleted the jaime/otelversion branch October 1, 2024 11:10
@github-actions github-actions bot removed this from the 7.58.0 milestone Oct 1, 2024
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.

6 participants