Skip to content

feat(franz-go): add orchestrion aspect for automatic instrumentation#4629

Merged
genesor merged 6 commits into
augusto/add-twmb-franz-go-integrationfrom
ben.db/franz-go-orchestrion
Apr 23, 2026
Merged

feat(franz-go): add orchestrion aspect for automatic instrumentation#4629
genesor merged 6 commits into
augusto/add-twmb-franz-go-integrationfrom
ben.db/franz-go-orchestrion

Conversation

@genesor

@genesor genesor commented Apr 2, 2026

Copy link
Copy Markdown
Member

What does this PR do?

Adds orchestrion support for the twmb/franz-go integration:

  • Adds orchestrion.yml aspect that hooks into kgo.NewClient() and appends WithTracing() to enable automatic distributed tracing
  • Registers the aspect in orchestrion/all
  • Adds an orchestrion integration test at internal/orchestrion/_integration/twmb_franz_go/
  • Adds the franz-go replace directive to the integration test module

Motivation

Enable automatic instrumentation of franz-go Kafka clients via orchestrion, matching the existing pattern used by other integrations (gRPC, segmentio/kafka-go, etc.).

Reviewer's Checklist

  • Changed code has unit tests for its functionality at or near 100% coverage.
  • System-Tests covering this feature have been added and enabled with the va.b.c-dev version tag.
  • There is a benchmark for any new code, or changes to existing code.
  • If this interacts with the agent in a new way, a system test has been added.
  • New code is free of linting errors. You can check this by running make lint locally.
  • New code doesn't break existing tests. You can check this by running make test locally.
  • Add an appropriate team label so this PR gets put in the right place for the release notes.
  • All generated files are up to date. You can check this by running make generate locally.
  • Non-trivial go.mod changes, e.g. adding new modules, are reviewed by @DataDog/dd-trace-go-guild. Make sure all nested modules are up to date by running make fix-modules locally.

@github-actions github-actions Bot added the apm:ecosystem contrib/* related feature requests or bugs label Apr 2, 2026
@codecov

codecov Bot commented Apr 2, 2026 •
edited
Loading

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 61.23%. Comparing base (97fc6d7) to head (671df50).

Additional details and impacted files

see 19 files with indirect coverage changes

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@datadog-prod-us1-6

datadog-prod-us1-6 Bot commented Apr 2, 2026 •
edited by datadog-datadog-prod-us1 Bot
Loading

Copy link
Copy Markdown

Tests

🎉 All green!

❄️ No new flaky tests detected
🧪 All tests passed

🎯 Code Coverage (details)
• Patch Coverage: 100.00%
• Overall Coverage: 61.12% (+0.04%)

This comment will be updated automatically if new data arrives.
🔗 Commit SHA: 3be6d77 | Docs | Datadog PR Page | Give us feedback!

@genesor
genesor force-pushed the ben.db/franz-go-orchestrion branch from d92d2ab to bc7a982 Compare April 2, 2026 12:01
kakkoyun
kakkoyun reviewed Apr 8, 2026
View reviewed changes
Comment thread internal/orchestrion/_integration/twmb_franz_go/twmb_franz_go.go Outdated
Base automatically changed from rarguelloF/franz-go-hooks to augusto/add-twmb-franz-go-integration April 22, 2026 09:11
@genesor
genesor force-pushed the ben.db/franz-go-orchestrion branch from bc7a982 to 7f24271 Compare April 23, 2026 08:41
@genesor
genesor force-pushed the ben.db/franz-go-orchestrion branch from 7f24271 to 607cec1 Compare April 23, 2026 08:54
@pr-commenter

pr-commenter Bot commented Apr 23, 2026 •
edited
Loading

Copy link
Copy Markdown

Benchmarks

Benchmark execution time: 2026-04-23 11:32:28

Comparing candidate commit 3be6d77 in PR branch ben.db/franz-go-orchestrion with baseline commit 97fc6d7 in branch augusto/add-twmb-franz-go-integration.

Found 0 performance improvements and 0 performance regressions! Performance is the same for 269 metrics, 9 unstable metrics.

Explanation

This is an A/B test comparing a candidate commit's performance against that of a baseline commit. Performance changes are noted in the tables below as:

  • 🟩 = significantly better candidate vs. baseline
  • 🟥 = significantly worse candidate vs. baseline

We compute a confidence interval (CI) over the relative difference of means between metrics from the candidate and baseline commits, considering the baseline as the reference.

If the CI is entirely outside the configured SIGNIFICANT_IMPACT_THRESHOLD (or the deprecated UNCONFIDENCE_THRESHOLD), the change is considered significant.

Feel free to reach out to #apm-benchmarking-platform on Slack if you have any questions.

More details about the CI and significant changes

You can imagine this CI as a range of values that is likely to contain the true difference of means between the candidate and baseline commits.

CIs of the difference of means are often centered around 0%, because often changes are not that big:

---------------------------------(------|---^--------)-------------------------------->
                              -0.6%    0%  0.3%     +1.2%
                                 |          |        |
         lower bound of the CI --'          |        |
sample mean (center of the CI) -------------'        |
         upper bound of the CI ----------------------'

As described above, a change is considered significant if the CI is entirely outside the configured SIGNIFICANT_IMPACT_THRESHOLD (or the deprecated UNCONFIDENCE_THRESHOLD).

For instance, for an execution time metric, this confidence interval indicates a significantly worse performance:

----------------------------------------|---------|---(---------^---------)---------->
                                       0%        1%  1.3%      2.2%      3.1%
                                                  |   |         |         |
       significant impact threshold --------------'   |         |         |
                      lower bound of CI --------------'         |         |
       sample mean (center of the CI) --------------------------'         |
                      upper bound of CI ----------------------------------'

@genesor
genesor marked this pull request as ready for review April 23, 2026 09:39
@genesor
genesor requested review from a team as code owners April 23, 2026 09:39
eliottness
eliottness reviewed Apr 23, 2026
View reviewed changes
Comment thread internal/orchestrion/_integration/twmb_franz_go/twmb_franz_go.go
@genesor
genesor merged commit 8129464 into augusto/add-twmb-franz-go-integration Apr 23, 2026
218 of 228 checks passed
@genesor
genesor deleted the ben.db/franz-go-orchestrion branch April 23, 2026 11:05
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@kakkoyun kakkoyun kakkoyun left review comments
@eliottness eliottness eliottness approved these changes

Assignees

No one assigned

Labels

apm:ecosystem contrib/* related feature requests or bugs

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@genesor @kakkoyun @eliottness