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-2147] add methods for converter ocb compatibility #31009

Merged

Conversation

jackgopack4
Copy link
Contributor

What does this PR do?

adds required methods so that otelcol/converter can be included and built with ocb

Motivation

https://datadoghq.atlassian.net/browse/OTEL-2236

Describe how to test/QA your changes

**Note: testing this is currently blocked by open-telemetry/opentelemetry-collector#11649; you can apply the changes in the linked PR/issue to ocb yourself or just wait until that PR is accepted

download latest ocb and build from source

$ git clone https://github.com/open-telemetry/opentelemetry-collector.git
$ cd opentelemetry-collector/cmd/builder
$ CGO_ENABLED=0 go build -o ocb -trimpath -ldflags='-s -w'

download an ocb manifest
$ wget https://test2-for-worker.haf208.cc/open-telemetry/opentelemetry-collector-releases/refs/heads/main/distributions/otelcol-contrib/manifest.yaml

add the following lines to add the converter to manifest.yaml:

converters:
  - gomod: github.com/DataDog/datadog-agent/comp/otelcol/converter/impl
    path: ./comp/otelcol/converter/impl

download a config file to test your collector
wget https://test2-for-worker.haf208.cc/open-telemetry/opentelemetry-collector-releases/refs/heads/main/distributions/otelcol-contrib/config.yaml

delete any sections from config.yaml referencing extensions "zpages", "pprof", or "healthcheck" (we need to make sure converter adds them back into the configuration)

build and run your custom collector

./ocb --config manifest.yaml
./_build/otelcol-contrib --config config.yaml

send test command in a new terminal window to verify configuration was modified
$ curl -k https://localhost:7777

  • check for "zpages/dd-autoconfigured" as well as pprof and healthcheck in the "enhanced_configuration" value

Possible Drawbacks / Trade-offs

cannot push automated test until upstream change is merged, JIRA card for this: https://datadoghq.atlassian.net/browse/OTEL-2238

Additional Notes

@jackgopack4 jackgopack4 requested a review from a team as a code owner November 12, 2024 19:50
@github-actions github-actions bot added medium review PR review might take time team/opentelemetry OpenTelemetry team labels Nov 12, 2024
@jackgopack4 jackgopack4 added qa/done QA done before merge and regressions are covered by tests changelog/no-changelog labels Nov 12, 2024
@jackgopack4 jackgopack4 added this to the 7.61.0 milestone Nov 12, 2024
@agent-platform-auto-pr
Copy link
Contributor

agent-platform-auto-pr bot commented Nov 12, 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=48943485 --os-family=ubuntu

Note: This applies to commit c1f36d7

Copy link

cit-pr-commenter bot commented Nov 12, 2024

Regression Detector

Regression Detector Results

Metrics dashboard
Target profiles
Run ID: 40691554-4115-4163-99e2-bf428ebe8b50

Baseline: 043922b
Comparison: c1f36d7
Diff

Optimization Goals: ✅ No significant changes detected

Fine details of change detection per experiment

perf experiment goal Δ mean % Δ mean % CI trials links
pycheck_lots_of_tags % cpu utilization +3.47 [-0.01, +6.94] 1 Logs
otel_to_otel_logs ingress throughput +1.01 [+0.32, +1.70] 1 Logs
file_to_blackhole_500ms_latency egress throughput +0.16 [-0.08, +0.40] 1 Logs
file_to_blackhole_300ms_latency egress throughput +0.06 [-0.14, +0.25] 1 Logs
file_to_blackhole_0ms_latency egress throughput +0.01 [-0.49, +0.51] 1 Logs
file_to_blackhole_100ms_latency egress throughput +0.01 [-0.32, +0.34] 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.10, +0.10] 1 Logs
tcp_syslog_to_blackhole ingress throughput -0.15 [-0.24, -0.07] 1 Logs
file_tree memory utilization -0.17 [-0.29, -0.05] 1 Logs
basic_py_check % cpu utilization -0.17 [-3.87, +3.53] 1 Logs
file_to_blackhole_1000ms_latency egress throughput -0.37 [-0.85, +0.12] 1 Logs
file_to_blackhole_1000ms_latency_linear_load egress throughput -0.47 [-0.95, +0.02] 1 Logs
quality_gate_idle memory utilization -0.57 [-0.61, -0.52] 1 Logs bounds checks dashboard
uds_dogstatsd_to_api_cpu % cpu utilization -0.65 [-1.37, +0.07] 1 Logs
quality_gate_idle_all_features memory utilization -0.81 [-0.90, -0.71] 1 Logs bounds checks dashboard

Bounds Checks: ❌ Failed

perf experiment bounds_check_name replicates_passed links
file_to_blackhole_0ms_latency lost_bytes 8/10
file_to_blackhole_100ms_latency lost_bytes 8/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 memory_usage 10/10
file_to_blackhole_300ms_latency memory_usage 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

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

@jackgopack4 jackgopack4 changed the title add methods for converter ocb compatibility [OTEL-2147] add methods for converter ocb compatibility Nov 13, 2024
@jackgopack4 jackgopack4 force-pushed the jackgopack4/refactor-otelcol-converter-ocb-support branch from f134dd9 to c1f36d7 Compare November 13, 2024 19:14
@jackgopack4
Copy link
Contributor Author

/merge

@dd-devflow
Copy link

dd-devflow bot commented Nov 13, 2024

Devflow running: /merge

View all feedbacks in Devflow UI.


2024-11-13 20:22:51 UTC ℹ️ MergeQueue: pull request added to the queue

The median merge time in main is 23m.


2024-11-13 20:22:52 UTC ℹ️ MergeQueue: pull request added to the queue

The median merge time in main is 23m.


2024-11-13 20:24:38 UTCMergeQueue: The checks failed on this merge request

Tests failed on this commit c54c54f:

What to do next?

  • Investigate the failures and when ready, re-add your pull request to the queue!
  • Any question, go check the FAQ.

@jackgopack4 jackgopack4 removed the request for review from IbraheemA November 13, 2024 20:37
@jackgopack4
Copy link
Contributor Author

/merge

@dd-devflow
Copy link

dd-devflow bot commented Nov 13, 2024

Devflow running: /merge

View all feedbacks in Devflow UI.


2024-11-13 20:39:25 UTC ℹ️ MergeQueue: pull request added to the queue

The median merge time in main is 23m.


2024-11-13 20:39:26 UTC ℹ️ MergeQueue: pull request added to the queue

The median merge time in main is 23m.

@dd-mergequeue dd-mergequeue bot merged commit 4de2511 into main Nov 13, 2024
217 checks passed
@dd-mergequeue dd-mergequeue bot deleted the jackgopack4/refactor-otelcol-converter-ocb-support branch November 13, 2024 21:17
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/opentelemetry OpenTelemetry team
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants