[otelcol] Fix missing defaults in unredacted print-config by EdgeN8v · Pull Request #14752 · open-telemetry/opentelemetry-collector

EdgeN8v · 2026-03-11T02:25:22Z

Description

Fixes an issue where otelcol print-config --mode=unredacted omits default values, causing its output structure to differ significantly from redacted mode.

Implementation details:
This PR introduces a new confmap.WithUnredacted() MarshalOption and an unredactedStringer interface within the mapstructure encoder. This allows the configuration to be marshaled natively without redaction, preserving all default values while cleanly decoupling the encoder from configopaque. The previous recursive post-processing workaround has been entirely removed.

Link to tracking issue

Fixes #14750

Testing

Removed obsolete tests related to the recursive workaround.
Updated TestPrintCommand in command_print_test.go to assert default values are correctly handled natively in unredacted mode.
Passed make test locally.

Documentation

Added .chloggen entry.

codspeed-hq · 2026-03-11T02:36:44Z

Merging this PR will not alter performance

⚠️

Unknown Walltime execution environment detected

Using the Walltime instrument on standard Hosted Runners will lead to inconsistent data.

For the most accurate results, we recommend using CodSpeed Macro Runners: bare-metal machines fine-tuned for performance measurement consistency.

✅ 7 untouched benchmarks
⏩ 76 skipped benchmarks¹

_{Comparing EdgeN8v:fix/14750-unredacted-defaults (b724310) with main (76ede07)}

76 benchmarks were skipped, so the baseline results were used instead. If they were deleted from the codebase, click here and archive them to remove them from the performance reports. ↩

codecov · 2026-03-11T02:40:31Z

Codecov Report

❌ Patch coverage is 92.59259% with 2 lines in your changes missing coverage. Please review.
✅ Project coverage is 91.23%. Comparing base (76ede07) to head (b724310).
⚠️ Report is 1 commits behind head on main.

Files with missing lines	Patch %	Lines
otelcol/command_print.go	71.42%	1 Missing and 1 partial ⚠️

❌ Your patch status has failed because the patch coverage (92.59%) is below the target coverage (95.00%). You can increase the patch coverage or adjust the target coverage.

Additional details and impacted files

@@            Coverage Diff             @@
##             main   #14752      +/-   ##
==========================================
- Coverage   91.24%   91.23%   -0.02%     
==========================================
  Files         697      697              
  Lines       44647    44658      +11     
==========================================
+ Hits        40738    40742       +4     
- Misses       2769     2774       +5     
- Partials     1140     1142       +2

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

EdgeN8v · 2026-03-12T01:17:54Z

Hi @axw, the slight coverage drop is just the basic err != nil branches for the config setup (getPrintableConfig, Marshal, NewResolver).

The core restoreSecrets logic is fully covered. I skipped mocking those framework errors to keep the tests clean.

jmacd

Days with a recursive function in them++. Thanks.

codeboten · 2026-03-12T17:13:41Z

-				// the whole component config is not defaulted.
-				"unredacted": `other: lala`,
+				"redacted":   `opaque: '[REDACTED]'`,
+				"unredacted": `opaque: '[REDACTED]'`,


is this value not expected to be unredacted as well?

Since default values aren't in the user's raw input, we don't have a cleartext source to restore them from. So it stays as [REDACTED].

I'm unresolving this as I think there may be another option. We can choose not to go with it, but we should still discuss whether this is acceptable.

axw

I'm not very familiar with this part of the code base, so I asked Claude Code to take a look. It came up with a different approach which will also work for default values (#14752 (comment)).

The approach is basically to introduce a new confmap.MarshalOption that disables redaction during marshaling. I think that seems like a simpler and more foolproof solution. What do you think?

The code it generated is at https://github.com/axw/opentelemetry-collector/tree/fix/14750-unredacted-defaults. I wouldn't necessarily use it as-is, just sharing for reference.

dmathieu · 2026-03-13T08:19:37Z

I haven't looked deeply into this, but I agree that the current approach (relying on the [REDACTED] value to unredact) isn't the most readable/clean approach. We can do better.

…nation URL in error messages Signed-off-by: EdgeN8v <ckx19921555595@gmail.com>

Fixes open-telemetry#14750 Signed-off-by: EdgeN8v <ckx19921555595@gmail.com>

Signed-off-by: EdgeN8v <ckx19921555595@gmail.com>

axw

One comment, otherwise LGTM

axw · 2026-03-16T06:02:57Z

+			if _, ok := from.Interface().(encoding.TextMarshaler); ok {
+				return from.String(), nil
+			}


This feels like quite a subtle tight coupling to configopaque.Opaque. Instead, perhaps we should introduce an interface like

type UnredactedStringer interface { UnredactedString() string }

and have configopaque.Opaque implement it.

…odecov

mx-psi · 2026-03-16T11:38:23Z

I would rather avoid adding public API to a stable module like configopaque for experimental functionality like print-config. While I think the solution proposed on this PR is clean, given that print-config is not still stable, I would like to explore what alternatives we have that don't require this new public API method (UnredactedString mehtod)

…nd extract confmap tests

dmathieu

The move to xconfmap is quite nice.

VihasMakwana · 2026-03-18T09:30:08Z

+			if _, ok := from.Interface().(encoding.TextMarshaler); ok {
+				return from.String(), nil
+			}


axw

Given that the new option is in xconfmap, and therefore unstable, I think we can go ahead with this and look into adding another interface later.

Co-authored-by: Vihas Makwana <121151420+VihasMakwana@users.noreply.github.com>

otelbot · 2026-04-06T12:51:36Z

Thank you for your contribution @EdgeN8v! 🎉 We would like to hear from you about your experience contributing to OpenTelemetry by taking a few minutes to fill out this survey.

…etry#14752) **Description** Fixes an issue where `otelcol print-config --mode=unredacted` omits default values, causing its output structure to differ significantly from `redacted` mode. *Implementation details:* This PR introduces a new `confmap.WithUnredacted()` `MarshalOption` and an `unredactedStringer` interface within the `mapstructure` encoder. This allows the configuration to be marshaled natively without redaction, preserving all default values while cleanly decoupling the encoder from `configopaque`. The previous recursive post-processing workaround has been entirely removed. **Link to tracking issue** Fixes open-telemetry#14750 **Testing** * Removed obsolete tests related to the recursive workaround. * Updated `TestPrintCommand` in `command_print_test.go` to assert default values are correctly handled natively in `unredacted` mode. * Passed `make test` locally. **Documentation** * Added `.chloggen` entry. --------- Signed-off-by: EdgeN8v <ckx19921555595@gmail.com> Co-authored-by: Damien Mathieu <42@dmathieu.com> Co-authored-by: Vihas Makwana <121151420+VihasMakwana@users.noreply.github.com> Co-authored-by: Pablo Baeyens <pablo.baeyens@datadoghq.com>

EdgeN8v requested a review from a team as a code owner March 11, 2026 02:25

EdgeN8v requested a review from axw March 11, 2026 02:25

jmacd approved these changes Mar 12, 2026

View reviewed changes

codeboten reviewed Mar 12, 2026

View reviewed changes

axw reviewed Mar 13, 2026

View reviewed changes

EdgeN8v added 9 commits March 16, 2026 13:33

fix(otlphttpexporter): unwrap url.Error to show actual modified desti…

18410b7

…nation URL in error messages Signed-off-by: EdgeN8v <ckx19921555595@gmail.com>

[otelcol] Fix unredacted print-config omitting default values

a283a19

Fixes open-telemetry#14750 Signed-off-by: EdgeN8v <ckx19921555595@gmail.com>

Fix changelog component name

c642ac7

Signed-off-by: EdgeN8v <ckx19921555595@gmail.com>

Fix govet shadow lint error

18ed377

Signed-off-by: EdgeN8v <ckx19921555595@gmail.com>

Add unit tests for restoreSecrets slice and nested logic

c6eb283

Signed-off-by: EdgeN8v <ckx19921555595@gmail.com>

Fix code formatting by adding blank line

88c822b

Signed-off-by: EdgeN8v <ckx19921555595@gmail.com>

Remove unused errOnlyRedacted field

10bb21d

Signed-off-by: EdgeN8v <ckx19921555595@gmail.com>

Fix struct field alignment after removing errOnlyRedacted

e3e74cf

Signed-off-by: EdgeN8v <ckx19921555595@gmail.com>

refactor: introduce confmap.MarshalOption for unredacted config printing

e84b6e6

EdgeN8v force-pushed the fix/14750-unredacted-defaults branch from f38d40a to e84b6e6 Compare March 16, 2026 05:37

EdgeN8v requested review from evan-bradley and mx-psi as code owners March 16, 2026 05:37

EdgeN8v added 3 commits March 16, 2026 13:45

fix: manually resolve test conflict and fix changelog yaml array format

ea53c2f

style: fix formatting, trailing spaces, and missing newlines

270327f

docs: specify issue number in changelog

c4fb3e6

axw reviewed Mar 16, 2026

View reviewed changes

EdgeN8v added 3 commits March 16, 2026 17:52

refactor: decouple mapstructure unredacted hook and format code

2a0bbb0

style: fix formatting

8885dbf

test: add missing unit tests for unredacted unmarshaling to satisfy C…

6b249c2

…odecov

build: run make gotidy to remove unused assert dependencies

c6b43b1

EdgeN8v added 2 commits March 17, 2026 10:17

refactor: use reflection for unredacted print, revert configopaque, a…

37e323e

…nd extract confmap tests

Merge branch 'main' into fix/14750-unredacted-defaults

0d0e628

dmathieu reviewed Mar 18, 2026

View reviewed changes

Comment thread confmap/internal/marshaloption.go

VihasMakwana reviewed Mar 18, 2026

View reviewed changes

axw approved these changes Mar 19, 2026

View reviewed changes

dmathieu approved these changes Mar 19, 2026

View reviewed changes

Apply suggestion from @VihasMakwana

4e12171

Co-authored-by: Vihas Makwana <121151420+VihasMakwana@users.noreply.github.com>

VihasMakwana approved these changes Mar 19, 2026

View reviewed changes

mx-psi approved these changes Mar 20, 2026

View reviewed changes

mx-psi enabled auto-merge March 20, 2026 09:32

Merge branch 'main' into fix/14750-unredacted-defaults

a7ba2c4

auto-merge was automatically disabled March 30, 2026 12:49
Pull Request is not mergeable

dmathieu added the ready-to-merge Code review completed; ready to merge by maintainers label Mar 30, 2026

Merge branch 'main' into fix/14750-unredacted-defaults

b724310

mx-psi enabled auto-merge April 6, 2026 12:21

mx-psi added this pull request to the merge queue Apr 6, 2026

Merged via the queue into open-telemetry:main with commit f594326 Apr 6, 2026
65 of 66 checks passed

Uh oh!

Conversation

EdgeN8v commented Mar 11, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

codspeed-hq Bot commented Mar 11, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Merging this PR will not alter performance

Footnotes

Uh oh!

codecov Bot commented Mar 11, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

EdgeN8v commented Mar 12, 2026

Uh oh!

jmacd left a comment

Choose a reason for hiding this comment

Uh oh!

codeboten Mar 12, 2026

Choose a reason for hiding this comment

Uh oh!

EdgeN8v Mar 13, 2026

Choose a reason for hiding this comment

Uh oh!

axw Mar 13, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

axw left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

dmathieu commented Mar 13, 2026

Uh oh!

axw left a comment

Choose a reason for hiding this comment

Uh oh!

axw Mar 16, 2026

Choose a reason for hiding this comment

Uh oh!

VihasMakwana Mar 18, 2026

Choose a reason for hiding this comment

Uh oh!

mx-psi commented Mar 16, 2026

Uh oh!

dmathieu left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

VihasMakwana Mar 18, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

axw left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

otelbot Bot commented Apr 6, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

7 participants

EdgeN8v commented Mar 11, 2026 •

edited

Loading

codspeed-hq Bot commented Mar 11, 2026 •

edited

Loading

codecov Bot commented Mar 11, 2026 •

edited

Loading

axw left a comment •

edited

Loading

axw left a comment •

edited

Loading