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

Document the new sub command "components" #2072

Closed
Chinwendu20 opened this issue Dec 3, 2022 · 12 comments
Closed

Document the new sub command "components" #2072

Chinwendu20 opened this issue Dec 3, 2022 · 12 comments
Labels
enhancement New feature or request good first issue Good for newcomers help wanted Extra attention is needed sig:collector

Comments

@Chinwendu20
Copy link

What needs to be changed?
A new sub-command has been added to the collector core. Lnk to merged PR

Additional context
The command displays the components available in a given distribution. You can use the update in the readme as a guide for documentation. This is an example of how the command works:

   ./otelcorecol components

Sample output:

buildinfo:
   command: otelcorecol
   description: Local OpenTelemetry Collector binary, testing only.
   version: 0.62.1-dev
receivers:
   - otlp
processors:
   - memory_limiter
   - batch
exporters:
   - otlp
   - otlphttp
   - logging
extensions:
   - zpages
   - memory_ballast

@Chinwendu20 Chinwendu20 added the bug Something isn't working label Dec 3, 2022
@Chinwendu20
Copy link
Author

Please the label bug is misleading. I do not know how to update that

@svrnm svrnm added enhancement New feature or request sig:collector and removed bug Something isn't working labels Dec 3, 2022
@svrnm
Copy link
Member

svrnm commented Dec 5, 2022

@Chinwendu20 do you want to give it a try yourself to add this to the docs?

@Chinwendu20
Copy link
Author

That would be cool. I might want to do that but as of now, let us leave this open for grabs but I do have a question. Should the documentation be in line with the most recent release of the open telemetry API? I ask this because I know some projects have documentation for each API release.

@cartermp
Copy link
Contributor

@Chinwendu20 Latest API version please!

@ishworg
Copy link

ishworg commented Feb 1, 2023

The components command is available from 0.67.0.

@Chinwendu20
Copy link
Author

Thanks @ishworg . Just got to see this message now @cartermp

@svrnm svrnm added help wanted Extra attention is needed good first issue Good for newcomers labels Dec 13, 2023
@nerudadhich
Copy link
Contributor

nerudadhich commented Mar 13, 2024

Hi @svrnm @Chinwendu20 I will update the document but not able to find where should we add this.
There are two places that I feel we can add.

  1. Create the Readme of component https://github.com/open-telemetry/opentelemetry-collector/tree/main/cmd/otelcorecol
  2. Somewhere here in doc https://opentelemetry.io/docs/collector/

Please suggest and I will be happy to add the document.

@svrnm
Copy link
Member

svrnm commented Mar 13, 2024

Hm, I can make 2 suggestions:

https://opentelemetry.io/docs/collector/configuration/
or
https://opentelemetry.io/docs/collector/troubleshooting/

cc @open-telemetry/collector-approvers

@mx-psi
Copy link
Member

mx-psi commented Mar 13, 2024

IMO this fits better in troubleshooting

@nerudadhich
Copy link
Contributor

nerudadhich commented Mar 13, 2024

Let me add this in troubleshooting first and then we can add a section in configuration as well if required. Thanks for prompt replies.

@nerudadhich
Copy link
Contributor

I have raised the PR, Please review and let me know if anything else need to add.

@cartermp
Copy link
Contributor

This is now merged. Thanks @nerudadhich!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request good first issue Good for newcomers help wanted Extra attention is needed sig:collector
Projects
None yet
Development

No branches or pull requests

6 participants