builder: avoid duplicate CLI error logging in generated main by Syedowais312 · Pull Request #14317 · open-telemetry/opentelemetry-collector

Syedowais312 · 2025-12-21T10:29:02Z

Problem

When running an invalid CLI command (for example otelcorecol foo), Cobra already prints a user-facing error message.

However, the builder-generated main.go also logs the same error using log.Fatalf, which results in duplicate error output.

Solution

This change updates the builder template to:

remove log.Fatalf from main()
exit with a non-zero status using os.Exit(1)
allow Cobra to fully own CLI error output

Result

Before

Error: unknown command "foo" for "otelcorecol"
Run 'otelcorecol --help' for usage.
collector server run finished with error: unknown command "foo" for "otelcorecol"

After

Error: unknown command "foo" for "otelcorecol"
Run 'otelcorecol --help' for usage.

Notes

Change is limited to cmd/builder/internal/builder/templates/main.go.tmpl
No behavior change for successful execution paths
Exit code behavior remains unchanged

Closes: #14302

linux-foundation-easycla · 2025-12-21T10:29:16Z

The committers listed above are authorized under a signed CLA.

✅ login: Syedowais312 / name: syed owais (bd3991a)

axw

LGTM, I suggest adding a comment to make it clear that we're intentionally not logging the error though.

cmd/builder/internal/builder/templates/main.go.tmpl

axw · 2026-01-05T02:26:34Z

@Syedowais312 can you please add a changelog entry? It's a small change, but still worthy of an enhancement changelog IMO.

Syedowais312 · 2026-01-05T16:18:13Z

@axw I’ve added a changelog entry and a comment in main.go.tmpl explaining the intentional omission of error logging. let me know if any further changes are needed.

axw · 2026-01-05T23:50:14Z

CHANGELOG.md

 - `cmd/mdatagen`: Add lint/ordering validation for metadata.yaml (#13781)
 - `pdata/xpdata`: Refactor JSON marshaling and unmarshaling to use `pcommon.Value` instead of `AnyValue`. (#13837)
 - `pkg/exporterhelper`: Expose `MergeCtx` in exporterhelper's queue batch settings` (#13742)
+- `cmd/builder`: Avoid duplicate CLI error logging in generated collector binaries by relying on cobra's error handling. (#14317)


@Syedowais312 we shouldn't update this file directly, please see https://github.com/open-telemetry/opentelemetry-collector/blob/main/CONTRIBUTING.md#adding-a-changelog-entry

cmd/builder/internal/builder/templates/main.go.tmpl

Syedowais312 · 2026-01-06T08:18:35Z

@axw Thanks for the pointer ,fixed the chloggen entry by removing empty optional fields, validated with make chlog-validate, and updated the PR. Please let me know if anything else is needed.

codecov · 2026-01-07T00:34:08Z

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 92.10%. Comparing base (c216239) to head (bd3991a).
⚠️ Report is 12 commits behind head on main.

Additional details and impacted files

@@           Coverage Diff           @@
##             main   #14317   +/-   ##
=======================================
  Coverage   92.10%   92.10%           
=======================================
  Files         668      668           
  Lines       41379    41379           
=======================================
  Hits        38114    38114           
  Misses       2227     2227           
  Partials     1038     1038

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

axw

LGTM, thanks @Syedowais312. CI is failing because the generated code in otelcorecol will need changing.

otelbot · 2026-01-08T20:49:06Z

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

…lemetry#14317) ### Problem When running an invalid CLI command (for example `otelcorecol foo`), Cobra already prints a user-facing error message. However, the builder-generated `main.go` also logs the same error using `log.Fatalf`, which results in duplicate error output. ### Solution This change updates the builder template to: - remove `log.Fatalf` from `main()` - exit with a non-zero status using `os.Exit(1)` - allow Cobra to fully own CLI error output ### Result **Before** ``` Error: unknown command "foo" for "otelcorecol" Run 'otelcorecol --help' for usage. collector server run finished with error: unknown command "foo" for "otelcorecol" ``` **After** ``` Error: unknown command "foo" for "otelcorecol" Run 'otelcorecol --help' for usage. ``` ### Notes - Change is limited to `cmd/builder/internal/builder/templates/main.go.tmpl` - No behavior change for successful execution paths - Exit code behavior remains unchanged **Closes:** open-telemetry#14302

This PR contains the following updates: | Package | Type | Update | Change | Pending | |---|---|---|---|---| | [go.opentelemetry.io/collector/component](https://github.com/open-telemetry/opentelemetry-collector) | require | minor | `v1.45.0` → `v1.50.0` | `v1.51.0` | | [go.opentelemetry.io/collector/component/componenttest](https://github.com/open-telemetry/opentelemetry-collector) | require | minor | `v0.139.0` → `v0.144.0` | `v0.145.0` | | [go.opentelemetry.io/collector/confmap](https://github.com/open-telemetry/opentelemetry-collector) | require | minor | `v1.45.0` → `v1.50.0` | `v1.51.0` | | [go.opentelemetry.io/collector/consumer](https://github.com/open-telemetry/opentelemetry-collector) | require | minor | `v1.45.0` → `v1.50.0` | `v1.51.0` | | [go.opentelemetry.io/collector/consumer/consumertest](https://github.com/open-telemetry/opentelemetry-collector) | require | minor | `v0.139.0` → `v0.144.0` | `v0.145.0` | | [go.opentelemetry.io/collector/pdata](https://github.com/open-telemetry/opentelemetry-collector) | require | minor | `v1.45.0` → `v1.50.0` | `v1.51.0` | | [go.opentelemetry.io/collector/processor](https://github.com/open-telemetry/opentelemetry-collector) | require | minor | `v1.45.0` → `v1.50.0` | `v1.51.0` | | [go.opentelemetry.io/collector/processor/processortest](https://github.com/open-telemetry/opentelemetry-collector) | require | minor | `v0.139.0` → `v0.144.0` | `v0.145.0` | | [go.uber.org/zap](https://github.com/uber-go/zap) | require | patch | `v1.27.0` → `v1.27.1` | | --- ### Release Notes <details> <summary>open-telemetry/opentelemetry-collector (go.opentelemetry.io/collector/component)</summary> ### [`v1.50.0`](https://github.com/open-telemetry/opentelemetry-collector/blob/HEAD/CHANGELOG.md#v1500v01440) ##### 🛑 Breaking changes 🛑 - `pkg/exporterhelper`: Change verbosity level for otelcol\_exporter\_queue\_batch\_send\_size metric to detailed. ([#14278](open-telemetry/opentelemetry-collector#14278)) - `pkg/service`: Remove deprecated `telemetry.disableHighCardinalityMetrics` feature gate. ([#14373](open-telemetry/opentelemetry-collector#14373)) - `pkg/service`: Remove deprecated `service.noopTracerProvider` feature gate. ([#14374](open-telemetry/opentelemetry-collector#14374)) ##### 🚩 Deprecations 🚩 - `exporter/otlp_grpc`: Rename `otlp` exporter to `otlp_grpc` exporter and add deprecated alias `otlp`. ([#14403](open-telemetry/opentelemetry-collector#14403)) - `exporter/otlp_http`: Rename `otlphttp` exporter to `otlp_http` exporter and add deprecated alias `otlphttp`. ([#14396](open-telemetry/opentelemetry-collector#14396)) ##### 💡 Enhancements 💡 - `cmd/builder`: Avoid duplicate CLI error logging in generated collector binaries by relying on cobra's error handling. ([#14317](open-telemetry/opentelemetry-collector#14317)) - `cmd/mdatagen`: Add the ability to disable attributes at the metric level and re-aggregate data points based off of these new dimensions ([#10726](open-telemetry/opentelemetry-collector#10726)) - `cmd/mdatagen`: Add optional `display_name` and `description` fields to metadata.yaml for human-readable component names ([#14114](open-telemetry/opentelemetry-collector#14114)) The `display_name` field allows components to specify a human-readable name in metadata.yaml. When provided, this name is used as the title in generated README files. The `description` field allows components to include a brief description in generated README files. - `cmd/mdatagen`: Validate stability level for entities ([#14425](open-telemetry/opentelemetry-collector#14425)) - `pkg/xexporterhelper`: Reenable batching for profiles ([#14313](open-telemetry/opentelemetry-collector#14313)) - `receiver/nop`: add profiles signal support ([#14253](open-telemetry/opentelemetry-collector#14253)) ##### 🧰 Bug fixes 🧰 - `pkg/exporterhelper`: Fix reference count bug in partition batcher ([#14444](open-telemetry/opentelemetry-collector#14444))  ### [`v1.49.0`](https://github.com/open-telemetry/opentelemetry-collector/blob/HEAD/CHANGELOG.md#v1490v01430) ##### 💡 Enhancements 💡 - `all`: Update semconv import to 1.38.0 ([#14305](open-telemetry/opentelemetry-collector#14305)) - `exporter/nop`: Add profiles support to nop exporter ([#14331](open-telemetry/opentelemetry-collector#14331)) - `pkg/pdata`: Optimize the size and pointer bytes for pdata structs ([#14339](open-telemetry/opentelemetry-collector#14339)) - `pkg/pdata`: Avoid using interfaces/oneof like style for optional fields ([#14333](open-telemetry/opentelemetry-collector#14333))  ### [`v1.48.0`](https://github.com/open-telemetry/opentelemetry-collector/blob/HEAD/CHANGELOG.md#v1480v01420) ##### 💡 Enhancements 💡 - `exporter/debug`: Add logging of dropped attributes, events, and links counts in detailed verbosity ([#14202](open-telemetry/opentelemetry-collector#14202)) - `extension/memory_limiter`: The memorylimiter extension can be used as an HTTP/GRPC middleware. ([#14081](open-telemetry/opentelemetry-collector#14081)) - `pkg/config/configgrpc`: Statically validate gRPC endpoint ([#10451](open-telemetry/opentelemetry-collector#10451)) This validation was already done in the OTLP exporter. It will now be applied to any gRPC client. - `pkg/service`: Add support to disabling adding resource attributes as zap fields in internal logging ([#13869](open-telemetry/opentelemetry-collector#13869)) Note that this does not affect logs exported through OTLP.  ### [`v1.47.0`](https://github.com/open-telemetry/opentelemetry-collector/blob/HEAD/CHANGELOG.md#v1470v01410) ##### 🛑 Breaking changes 🛑 - `pkg/config/confighttp`: Use configoptional.Optional for confighttp.ClientConfig.Cookies field ([#14021](open-telemetry/opentelemetry-collector#14021)) ##### 💡 Enhancements 💡 - `pkg/config/confighttp`: Setting `compression_algorithms` to an empty list now disables automatic decompression, ignoring Content-Encoding ([#14131](open-telemetry/opentelemetry-collector#14131)) - `pkg/service`: Update semantic conventions from internal telemetry to v1.37.0 ([#14232](open-telemetry/opentelemetry-collector#14232)) - `pkg/xscraper`: Implement xscraper for Profiles. ([#13915](open-telemetry/opentelemetry-collector#13915)) ##### 🧰 Bug fixes 🧰 - `pkg/config/configoptional`: Ensure that configoptional.None values resulting from unmarshaling are equivalent to configoptional.Optional zero value. ([#14218](open-telemetry/opentelemetry-collector#14218))  ### [`v1.46.0`](https://github.com/open-telemetry/opentelemetry-collector/blob/HEAD/CHANGELOG.md#v1460v01400) ##### 💡 Enhancements 💡 - `cmd/mdatagen`: `metadata.yaml` now supports an optional `entities` section to organize resource attributes into logical entities with identity and description attributes ([#14051](open-telemetry/opentelemetry-collector#14051)) When entities are defined, mdatagen generates `AssociateWith{EntityType}()` methods on ResourceBuilder that associate resources with entity types using the entity refs API. The entities section is backward compatible - existing metadata.yaml files without entities continue to work as before. - `cmd/mdatagen`: Add semconv reference for metrics ([#13920](open-telemetry/opentelemetry-collector#13920)) - `connector/forward`: Add support for Profiles to Profiles ([#14092](open-telemetry/opentelemetry-collector#14092)) - `exporter/debug`: Disable sending queue by default ([#14138](open-telemetry/opentelemetry-collector#14138)) The recently added sending queue configuration in Debug exporter was enabled by default and had a problematic default size of 1. This change disables the sending queue by default. Users can enable and configure the sending queue if needed. - `pkg/config/configoptional`: Mark `configoptional.AddEnabledField` as beta ([#14021](open-telemetry/opentelemetry-collector#14021)) - `pkg/otelcol`: This feature has been improved and tested; secure-by-default redacts configopaque values ([#12369](open-telemetry/opentelemetry-collector#12369)) ##### 🧰 Bug fixes 🧰 - `all`: Ensure service service.instance.id is the same for all the signals when it is autogenerated. ([#14140](open-telemetry/opentelemetry-collector#14140))  </details> <details> <summary>uber-go/zap (go.uber.org/zap)</summary> ### [`v1.27.1`](https://github.com/uber-go/zap/releases/tag/v1.27.1) [Compare Source](uber-go/zap@v1.27.0...v1.27.1) Enhancements: - [#1501][]: prevent `Object` from panicking on nils - [#1511][]: Fix a race condition in `WithLazy`. Thanks to [@rabbbit](https://github.com/rabbbit), [@alshopov](https://github.com/alshopov), [@jquirke](https://github.com/jquirke), [@arukiidou](https://github.com/arukiidou) for their contributions to this release. [#1501]: uber-go/zap#1501 [#1511]: uber-go/zap#1511 </details> --- ### Configuration 📅 **Schedule**: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined). 🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied. ♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox. 👻 **Immortal**: This PR will be recreated if closed unmerged. Get [config help](https://github.com/renovatebot/renovate/discussions) if that's undesired. --- - [ ] If you want to rebase/retry this PR, check this box --- This PR has been generated by [Renovate Bot](https://github.com/renovatebot/renovate).  Reviewed-on: https://gitea.t000-n.de/t.behrendt/tracebasedlogsampler/pulls/25 Reviewed-by: t.behrendt <t.behrendt@noreply.localhost> Co-authored-by: Renovate Bot <renovate@t00n.de> Co-committed-by: Renovate Bot <renovate@t00n.de>

Cobra already prints the user-facing error and usage on Execute() failure. Using cobra.CheckErr(cmd.Execute()) causes duplicate error output. This change aligns cmd/builder and cmd/mdatagen with the previously accepted pattern (PR #14317): let Cobra own CLI messaging and have main() only control the exit code.

builder: avoid duplicate CLI error logging in generated main

bff5b85

Syedowais312 requested a review from a team as a code owner December 21, 2025 10:29

Syedowais312 requested a review from evan-bradley December 21, 2025 10:29

axw approved these changes Jan 5, 2026

View reviewed changes

cmd/builder/internal/builder/templates/main.go.tmpl Show resolved Hide resolved

Merge branch 'main' into fix/ocb-duplicate-cli-error-log

eeb43e7

Syedowais312 requested a review from axw January 5, 2026 16:18

axw requested changes Jan 5, 2026

View reviewed changes

cmd/builder: clarify CLI error handling and update changelog

70644ec

Syedowais312 force-pushed the fix/ocb-duplicate-cli-error-log branch from 18b3e17 to 70644ec Compare January 6, 2026 08:16

Syedowais312 requested a review from axw January 6, 2026 08:18

Merge branch 'main' into fix/ocb-duplicate-cli-error-log

ff649d5

axw approved these changes Jan 7, 2026

View reviewed changes

cmd/otelcorecol: regenerate generated code

75db0fb

dmathieu approved these changes Jan 7, 2026

View reviewed changes

Syedowais312 added 2 commits January 7, 2026 14:19

Merge branch 'main' into fix/ocb-duplicate-cli-error-log

4f49aea

Merge branch 'main' into fix/ocb-duplicate-cli-error-log

bd3991a

bogdandrutu approved these changes Jan 8, 2026

View reviewed changes

bogdandrutu added this pull request to the merge queue Jan 8, 2026

Merged via the queue into open-telemetry:main with commit 4b6b865 Jan 8, 2026
62 checks passed

dmathieu mentioned this pull request Jan 13, 2026

Avoid duplicate error output between Cobra and otelcol logging #14302

Closed

dsevr mentioned this pull request Jan 16, 2026

Avoid duplicate Cobra CLI error output in generated commands #14436

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

builder: avoid duplicate CLI error logging in generated main#14317

builder: avoid duplicate CLI error logging in generated main#14317
bogdandrutu merged 7 commits intoopen-telemetry:mainfrom
Syedowais312:fix/ocb-duplicate-cli-error-log

Syedowais312 commented Dec 21, 2025 •

edited

Loading

Uh oh!

linux-foundation-easycla bot commented Dec 21, 2025 •

edited

Loading

Uh oh!

axw left a comment

Uh oh!

Uh oh!

axw commented Jan 5, 2026

Uh oh!

Syedowais312 commented Jan 5, 2026

Uh oh!

axw Jan 5, 2026

Uh oh!

Uh oh!

Syedowais312 commented Jan 6, 2026

Uh oh!

codecov bot commented Jan 7, 2026 •

edited

Loading

Uh oh!

axw left a comment •

edited

Loading

Uh oh!

Uh oh!

otelbot bot commented Jan 8, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

Conversation

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

Uh oh!

Problem

Solution

Result

Notes

Uh oh!

linux-foundation-easycla bot commented Dec 21, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

axw left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

axw commented Jan 5, 2026

Uh oh!

Syedowais312 commented Jan 5, 2026

Uh oh!

axw Jan 5, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Syedowais312 commented Jan 6, 2026

Uh oh!

codecov bot commented Jan 7, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

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 Jan 8, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

Syedowais312 commented Dec 21, 2025 •

edited

Loading

linux-foundation-easycla bot commented Dec 21, 2025 •

edited

Loading

codecov bot commented Jan 7, 2026 •

edited

Loading

axw left a comment •

edited

Loading