Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update builder README instructions to include required modules #4664

Merged
merged 1 commit into from
Jan 11, 2022
Merged

Update builder README instructions to include required modules #4664

merged 1 commit into from
Jan 11, 2022

Conversation

shelbyspees
Copy link
Contributor

Description:

Per this Slack thread, the builder was recently updated not to include any components by default.

This PR updates the README's TL;DR example to explicitly include the required core collector modules (OTLP receiver, batch processor, and logging exporter). Without them, the collector you build following those instructions fails to run.

Link to tracking issue:

n/a (I just went ahead and opened this PR)

Testing:

To reproduce the failure:

  • Clone open-telemetry/opentelemetry-collector at bed95f1
  • Navigate into cmd/builder
  • Follow TL;DR instructions, creating ~/.otelcol-builder.yaml that only includes alibabacloudlogserviceexporter and no other modules
  • Build the collector
  • Run the collector using the provided /tmp/otelcol.yaml in the instructions
  • You should get the following error: unknown receivers type "otlp" for "otlp"

After rebuilding the collector with the updated ~/.otelcol-builder.yaml listing all the required modules, it will run successfully.

@shelbyspees shelbyspees requested review from a team and bogdandrutu January 11, 2022 00:06
@codecov
Copy link

codecov bot commented Jan 11, 2022

Codecov Report

Merging #4664 (adac549) into main (bed95f1) will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##             main    #4664   +/-   ##
=======================================
  Coverage   90.68%   90.68%           
=======================================
  Files         179      179           
  Lines       10618    10618           
=======================================
  Hits         9629     9629           
  Misses        767      767           
  Partials      222      222           

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update bed95f1...adac549. Read the comment docs.

Copy link
Member

@Aneurysm9 Aneurysm9 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Might also be good to update the fuller example under Configuration as that would build a collector with only an exporter.

@bogdandrutu bogdandrutu added the Skip Changelog PRs that do not require a CHANGELOG.md entry label Jan 11, 2022
@bogdandrutu
Copy link
Member

@shelbyspees per @Aneurysm9 feedback, please consider a separate PR to address that feedback :)

@bogdandrutu bogdandrutu merged commit 1896745 into open-telemetry:main Jan 11, 2022
@shelbyspees shelbyspees deleted the update-builder-readme branch January 11, 2022 17:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Skip Changelog PRs that do not require a CHANGELOG.md entry
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants