search

open-telemetry / opentelemetry.io

The OpenTelemetry website and documentation
https://opentelemetry.io
Creative Commons Attribution 4.0 International
535 stars 1.17k forks source link

Document the new sub command "components" #2072

Closed Chinwendu20 closed 7 months ago

Chinwendu20 commented 1 year ago

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 commented 1 year ago

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

svrnm commented 1 year ago

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

Chinwendu20 commented 1 year ago

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 commented 1 year ago

@Chinwendu20 Latest API version please!

ishworg commented 1 year ago

The components command is available from 0.67.0.

Chinwendu20 commented 1 year ago

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

nerudadhich commented 7 months ago

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 commented 7 months ago

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 commented 7 months ago

IMO this fits better in troubleshooting

nerudadhich commented 7 months ago

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 commented 7 months ago

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

cartermp commented 7 months ago

This is now merged. Thanks @nerudadhich!