feat(contrib): add twmb/franz-go integration by igoragoli · Pull Request #4250 · DataDog/dd-trace-go

igoragoli · 2025-12-11T08:41:28Z

What does this PR do?

Adds a twmb/franz-go integration.

Motivation

#2735

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 ./scripts/lint.sh locally.
Add an appropriate team label so this PR gets put in the right place for the release notes.
Non-trivial go.mod changes, e.g. adding new modules, are reviewed by @DataDog/dd-trace-go-guild.

Unsure? Have a question? Request a review!

pr-commenter · 2025-12-11T08:42:30Z

Benchmarks

Benchmark execution time: 2026-04-23 13:46:48

Comparing candidate commit e208912 in PR branch augusto/add-twmb-franz-go-integration with baseline commit 1e2f4d4 in branch main.

Found 0 performance improvements and 0 performance regressions! Performance is the same for 271 metrics, 7 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 ----------------------------------'

datadog-official · 2025-12-18T14:36:25Z

🎉 All green!

❄️ No new flaky tests detected
🧪 All tests passed

🎯 Code Coverage (details)
• Patch Coverage: 100.00%
• Overall Coverage: 61.01% (+4.36%)

_{This comment will be updated automatically if new data arrives.

🔗 Commit SHA: e208912 | Docs | Datadog PR Page | Give us feedback!}

codecov · 2025-12-24T13:23:02Z

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 61.20%. Comparing base (1e2f4d4) to head (97fc6d7).

Additional details and impacted files

Files with missing lines	Coverage Δ
ddtrace/tracer/option.go	`84.11% <ø> (ø)`
instrumentation/packages.go	`6.49% <ø> (ø)`
internal/stacktrace/contribs_generated.go	`100.00% <100.00%> (ø)`

... and 437 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.

chatgpt-codex-connector

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: 97fc6d7ed4

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

Open a pull request for review
Mark a draft as ready
Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

chatgpt-codex-connector · 2026-04-22T10:31:24Z

+	for i, h := range c.record.Headers {
+		if h.Key == key {
+			c.record.Headers[i].Value = []byte(val)
+			return


Remove duplicate Kafka propagation headers

When a record already contains multiple headers for the same propagation key (franz-go stores headers as a slice, so this can happen when forwarding or reusing records), this return updates only the first value and leaves stale duplicates behind. ForeachKey later passes every duplicate to tracer.Extract; W3C extraction rejects duplicate traceparent, and Datadog extraction can let a later stale duplicate overwrite the value, so downstream consumers may lose or attach to the wrong parent context.

Useful? React with 👍 / 👎.

@igoragoli Does this make sense to you?

When a record already contains multiple headers for the same propagation key (franz-go stores headers as a slice, so this can happen when forwarding or reusing records)

Thank you, Dario! I have to check this assumption. I'll look into it later today :)

darccio

LGTM, although I'd address the Codex finding.

…lution

…4629) ### 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](https://github.com/DataDog/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.

genesor

LGTM! Great work 🚀

…e, apply Set to all occurences

Teko012 · 2026-04-24T10:26:07Z

Do you know which version are you targeting this for?

- Adds a [twmb/franz-go](https://github.com/twmb/franz-go?tab=readme-ov-file) integration.  #2735   - [x] Changed code has unit tests for its functionality at or near 100% coverage. - [ ] [System-Tests](https://github.com/DataDog/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 `./scripts/lint.sh` locally. - [ ] Add an appropriate team label so this PR gets put in the right place for the release notes. - [ ] Non-trivial go.mod changes, e.g. adding new modules, are reviewed by @DataDog/dd-trace-go-guild. Unsure? Have a question? Request a review! Co-authored-by: genesor <[email protected]> Co-authored-by: rarguelloF <[email protected]> Co-authored-by: augusto.deoliveira <[email protected]>

genesor · 2026-04-24T13:26:34Z

Hi @Teko012, we've included this PR in the ongoing v2.8.0 release, https://github.com/DataDog/dd-trace-go/tree/release-v2.8.x

It's currently being tested internally and should be released soon.

jmsbtlr111 · 2026-04-29T18:05:13Z

Looking forward to this addition! Thank you all who contributed.

igoragoli force-pushed the augusto/add-twmb-franz-go-integration branch from 53976be to 1d2f77e Compare December 18, 2025 14:28

igoragoli added 26 commits February 2, 2026 10:30

init carrier.go from local example

52e267a

copy types.go from segmentio/kafka-go

8fe66b6

rename Message to Record

36834c1

add a TODO for renaming the carrier

cfa0446

don't use kgo, use the structs/interfaces on types.go

78cddfb

simplify comments

4554540

fix Set()

28af618

copy tracer.go from segmentio/kafka-go

568e830

add PackageTwmbFranzGo to packages.go

de7c8a7

point to the PackageTwmbFranzGo instrumentation

2651f5a

make comments on tracer.go standardized

7fc0ba6

copy tracing.go from segmentio/kafka-go

3f39c73

change header and componentName

2fdab74

update StartConsumeSpan

f95df8b

update StartProduceSpan

7a9193e

exporting KafkaHeadersCarrier

bbf3152

tracer.go is now options.go

b0dd43a

forgot the constructor

ec257bc

remove question

fc8d8f1

copy dsm.go from segmentio/kafka-go and edit it

111bbaa

add tracing_test.go

e652f17

add tracing.go based on the one on segmentio/kafka-go

e1106c0

small fixes on tracing.go

5e3aac6

fix internal/tracing path on tracing.go

08e3097

add franz-go go.mod

012083e

init kgo.go with hooks for setting bootstrap servers

965ce9a

chatgpt-codex-connector Bot reviewed Apr 22, 2026

View reviewed changes

darccio approved these changes Apr 22, 2026

View reviewed changes

genesor and others added 7 commits April 23, 2026 10:23

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

2577cf6

test(franz-go): add orchestrion integration test

1f6fe85

chore(franz-go): register aspect in orchestrion/all

11c6e98

fix(franz-go): remove unused createTopic from integration test

607cec1

test(franz-go): add ellipsis and no-args orchestrion aspect coverage

671df50

fix(franz-go): use per-test topic/group to avoid shared-container pol…

3be6d77

…lution

genesor requested a review from a team as a code owner April 23, 2026 11:05

eliottness approved these changes Apr 23, 2026

View reviewed changes

genesor approved these changes Apr 23, 2026

View reviewed changes

igoragoli added 2 commits April 23, 2026 15:04

feat(franz-go): apply ForeachKey's handler only to the first occurenc…

941413e

…e, apply Set to all occurences

chore(franz-go): format and lint

e208912

igoragoli enabled auto-merge April 23, 2026 13:14

genesor disabled auto-merge April 23, 2026 13:14

gh-worker-dd-devflow-36fce6 Bot added mergequeue-status: waiting mergequeue-status: queued mergequeue-status: in_progress and removed mergequeue-status: waiting mergequeue-status: queued labels Apr 23, 2026

gh-worker-dd-mergequeue-cf854d Bot merged commit 4dab362 into main Apr 23, 2026
240 checks passed

gh-worker-dd-devflow-36fce6 Bot removed the mergequeue-status: in_progress label Apr 23, 2026

gh-worker-dd-mergequeue-cf854d Bot deleted the augusto/add-twmb-franz-go-integration branch April 23, 2026 14:02

gh-worker-dd-devflow-36fce6 Bot added the mergequeue-status: done label Apr 23, 2026

rarguelloF mentioned this pull request Jun 2, 2026

proposal: integrate with github.com/twmb/franz-go #2735

Closed

Uh oh!

Conversation

igoragoli commented Dec 11, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

What does this PR do?

Motivation

Reviewer's Checklist

Uh oh!

pr-commenter Bot commented Dec 11, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Benchmarks

Explanation

More details about the CI and significant changes

Uh oh!

datadog-official Bot commented Dec 18, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

codecov Bot commented Dec 24, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

chatgpt-codex-connector Bot left a comment

Choose a reason for hiding this comment

💡 Codex Review

Uh oh!

chatgpt-codex-connector Bot Apr 22, 2026

Choose a reason for hiding this comment

Uh oh!

darccio Apr 22, 2026

Choose a reason for hiding this comment

Uh oh!

igoragoli Apr 23, 2026

Choose a reason for hiding this comment

Uh oh!

darccio left a comment

Choose a reason for hiding this comment

Uh oh!

genesor left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Teko012 commented Apr 24, 2026

Uh oh!

genesor commented Apr 24, 2026

Uh oh!

jmsbtlr111 commented Apr 29, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

7 participants

igoragoli commented Dec 11, 2025 •

edited

Loading

pr-commenter Bot commented Dec 11, 2025 •

edited

Loading

datadog-official Bot commented Dec 18, 2025 •

edited

Loading

codecov Bot commented Dec 24, 2025 •

edited

Loading