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

Add default Collector configuration path to Configuration docs #3940

Merged
merged 10 commits into from
Feb 7, 2024

Conversation

theletterf
Copy link
Member

@theletterf theletterf commented Feb 5, 2024

Fixes #3929. Preview: https://deploy-preview-3940--opentelemetry.netlify.app/docs/collector/configuration/

I've added two new sections:

  • Location of the default config file and how to set a different one (and validate it).
  • How to override settings using the --set option.

Most of the information was taken from https://github.com/open-telemetry/opentelemetry-collector/blob/fa1b24184cb20ed0584457ea68c49c908da5f988/service/README.md?plain=1#L5, assuming that it applies to the otelcol binary as well, though confirmation is required.

Some questions:

  • Should we add the default location for Windows? I couldn't find what that is.
  • Do the options described in the otelcorecol README file apply?

Note: It'd be really, really great to revive open-telemetry/opentelemetry-collector#5654

@theletterf theletterf requested review from a team and codeboten and removed request for a team February 5, 2024 09:59
@theletterf theletterf self-assigned this Feb 5, 2024
@theletterf theletterf requested a review from a team February 5, 2024 09:59
@theletterf
Copy link
Member Author

PTAL. I've made the override examples more realistic and edited the location paragraph to make it a bit more... flexible.

Comment on lines +883 to +890
```shell
# The following example sets the verbosity
# level of the debug exporter to 'detailed'
otelcol --set "exporters::debug::verbosity=detailed"
# The following example overrides gRPC
# settings for the OTLP receiver
otelcol --set "receivers::otlp::protocols::grpc={endpoint:localhost:4317, compression: gzip}"
```
Copy link
Member

Choose a reason for hiding this comment

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

@bogdandrutu do you think having these examples make sense?

Copy link
Member Author

Choose a reason for hiding this comment

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

If they're syntactically correct, could we merge and review later?

Copy link
Member

Choose a reason for hiding this comment

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

👍 let's do this

Copy link
Member Author

Choose a reason for hiding this comment

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

Sweet! Could you approve? Thanks!

@svrnm svrnm merged commit 03cc9c6 into main Feb 7, 2024
16 checks passed
@svrnm svrnm deleted the theletterf-3929-add-collector-config-path branch February 7, 2024 10:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Configuration
4 participants