feat(outputs.opentelemetry): Add a config option for specifying name/field separator by mchrome · Pull Request #19156 · influxdata/telegraf

mchrome · 2026-06-24T12:32:48Z

Summary

This PR adds an option to specify a separator for LineProtocol's name/field when converting to OpenTelemtry format, similar to how it is done in graphite's output plugin with graphite_separator option.

This PR relies on changes in a dependency: influxdata/influxdb-observability#341. From my understanding, the team behind telegraf has write access there too, so it would be great if you could review that one also. Until that PR is merged, i replaced the dependency "infuxdb-observability/influx2otel" in go.mod with my fork of it, so tests could pass.

For context: there was another attempt by me to fix this issue here #18680, but after the review i realized it was not the right approach. Sorry for not getting back at you there.

Checklist

No AI generated code was used in this PR
AI generated code used in this PR follows the InfluxData Policy on AI-Generated Code Contributions

Related issues

resolves #18251

…field separator

mchrome · 2026-06-25T13:14:23Z

@srebhan Hi, could you take a look at this? Thanks.

skartikey

Docs: the new otel_name_separator option isn't in sample.conf or README.md. Please add it to sample.conf and run make docs to regenerate the README.

skartikey · 2026-06-29T10:36:16Z


 godebug x509negativeserial=1

+replace github.com/influxdata/influxdb-observability/influx2otel => github.com/mchrome/influxdb-observability/influx2otel v0.0.0-20260623155732-db200540d054


This can't land on master. The real behavior lives in influxdb-observability#341, so that one needs to be reviewed, merged, and released first; then bump influx2otel here and drop the replace. Note influx2otel, common, and otel2influx are versioned together (currently v0.5.12), so the bump will likely move all three.

Got you. Is there anything i can do to get that PR reviewed and merged?

skartikey · 2026-06-29T10:37:13Z

-	Coralogix   *CoralogixConfig  `toml:"coralogix"`
+	Timeout           config.Duration   `toml:"timeout"`
+	Compression       string            `toml:"compression"`
+	OtelNameSeparator string            `toml:"otel_name_separator"`


otel_name_separator repeats "otel". name_separator (or just separator) reads better. Config is user-facing API and renaming after release is breaking, so worth settling now.

Renamed it here dfcab49.

skartikey · 2026-06-29T10:38:33Z

 	require.JSONEq(t, string(expectJSON), string(gotJSON))
 }

+func TestOpenTelemetrySeparator(t *testing.T) {


the new tests only cover .. Backward compatibility relies on the default _ path through Connect() producing the same output as before, but nothing asserts that (the existing default tests inject the converter directly / use the old constructor). A test that calls Connect() with the default and asserts mem_used_percent would lock that in.

I rewrote the old tests in 894adfa because using the old constructor doesn't make much sense anymore since the plugin only uses the new one. Now they don't inject converters directly and create them through Connect(). Also added the test you described in 2eb45e5.

skartikey · 2026-06-29T10:39:05Z

+	require.JSONEq(t, string(expectJSON), string(gotJSON))
+}
+
+func TestOpenTelemetrySeparatorHTTPJSON(t *testing.T) {


the io.ReadAll error branch returns without w.WriteHeader(http.StatusInternalServerError), unlike the protobuf variant.

Added in 9fd0978

…irectly

…in HTTPJson tests

mchrome · 2026-07-23T11:41:11Z

@skartikey Hi, is there anything more I could do to get this merged? Don't really know who I can ask for a review on influxdata/influxdb-observability#341

skartikey · 2026-07-23T17:07:50Z

@mchrome Thanks for the PR, and no worries about the earlier one. The approach here looks good and the tests are solid.

The main thing is that we can't merge this while go.mod carries a replace pointing at your personal fork. That dependency change needs to go in first: let's get influxdb-observability#341 reviewed, merged, and cut as a release, then come back here to drop the replace and bump influx2otel to the released version. I'll take a look at #341.

One code point to sort while that's in flight: NameSeparator is defaulted in the init() factory but there's no empty-string fallback in Connect() the way Compression and Timeout have one, and the way the graphite serializer you modeled this on does (graphite.go, "if s.Separator == "" { s.Separator = "." }"). Right now a plugin built outside that factory ends up with an empty separator, which is actually why the three reworked tests run with "" today. Either add the same guard in Connect(), or if you want to let users set an empty separator on purpose, document that in sample.conf. I'd lean toward the guard for consistency.

mchrome · 2026-07-31T11:43:12Z

One code point to sort while that's in flight: NameSeparator is defaulted in the init() factory but there's no empty-string fallback in Connect() the way Compression and Timeout have one, and the way the graphite serializer you modeled this on does (graphite.go, "if s.Separator == "" { s.Separator = "." }"). Right now a plugin built outside that factory ends up with an empty separator, which is actually why the three reworked tests run with "" today. Either add the same guard in Connect(), or if you want to let users set an empty separator on purpose, document that in sample.conf. I'd lean toward the guard for consistency.

Thank you for your feedback! I added the guard in c8c7af3. Let me know when you take a look at influxdata/influxdb-observability#341.

telegraf-tiger · 2026-07-31T12:10:00Z

Download PR build artifacts for linux_amd64.tar.gz, darwin_arm64.tar.gz, and windows_amd64.zip.
Downloads for additional architectures and packages are available below.

☺️ This pull request doesn't significantly change the Telegraf binary size (less than 1%)

📦 Click here to get additional PR build artifacts

Artifact URLs

. DEB	. RPM	. TAR . GZ	. ZIP
amd64.deb	aarch64.rpm	darwin_amd64.tar.gz	windows_amd64.zip
arm64.deb	armel.rpm	darwin_arm64.tar.gz	windows_arm64.zip
armel.deb	armv6hl.rpm	freebsd_amd64.tar.gz	windows_i386.zip
armhf.deb	i386.rpm	freebsd_armv7.tar.gz
i386.deb	ppc64le.rpm	freebsd_i386.tar.gz
mips.deb	riscv64.rpm	linux_amd64.tar.gz
mipsel.deb	s390x.rpm	linux_arm64.tar.gz
ppc64el.deb	x86_64.rpm	linux_armel.tar.gz
riscv64.deb		linux_armhf.tar.gz
s390x.deb		linux_i386.tar.gz
		linux_mips.tar.gz
		linux_mipsel.tar.gz
		linux_ppc64le.tar.gz
		linux_riscv64.tar.gz
		linux_s390x.tar.gz

feat(outputs.opentelemetry): Add a config option for specifying name/…

d5aff96

…field separator

telegraf-tiger Bot added feat Improvement on an existing feature such as adding a new setting/mode to an existing plugin plugin/output 1. Request for new output plugins 2. Issues/PRs that are related to out plugins labels Jun 24, 2026

skartikey reviewed Jun 29, 2026

View reviewed changes

srebhan assigned skartikey Jul 1, 2026

mchrome added 5 commits July 3, 2026 15:26

Add description of the new config field to sample.conf & readme

af4cbc5

Rename otel_name_separator to name_separator

dfcab49

Use Connect() in all test functions instead of injecting converters d…

894adfa

…irectly

Add status 500 header to response when failing to parse request body …

9fd0978

…in HTTPJson tests

Add a new test that uses the default name separator

2eb45e5

Add a guard in case of an empty separator value

c8c7af3


		godebug x509negativeserial=1

		replace github.com/influxdata/influxdb-observability/influx2otel => github.com/mchrome/influxdb-observability/influx2otel v0.0.0-20260623155732-db200540d054

Uh oh!

Conversation

mchrome commented Jun 24, 2026

Summary

Checklist

Related issues

Uh oh!

mchrome commented Jun 25, 2026

Uh oh!

skartikey left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

mchrome commented Jul 23, 2026

Uh oh!

skartikey commented Jul 23, 2026

Uh oh!

mchrome commented Jul 31, 2026

Uh oh!

telegraf-tiger Bot commented Jul 31, 2026

Artifact URLs

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants