open-telemetry/opentelemetry-collector
Ver no GitHubProvide examples on how to create components
Open
#5.675 aberto em 12 de jul. de 2022
area:documentationeasygood first issue
Métricas do repositório
- Stars
- (7.237 stars)
- Métricas de merge de PR
- (Métricas PR pendentes)
Description
EDIT: I have kept all original text (with strikethrough) but have made modifications based on feedback
It would be very helpful and improve usability if an examples were was provided for the different a components like receivers, processor, exporters and extensions. This would simplify the process of creating a component for new users.
Examples could be added to the Go documentation for the component package. Refer to Testable Examples in Go for more details.
This request follows a discussion with @mx-psi.
Tasks
- Add Building a Trace Receiver reference to collector contrib Adding New Components section (https://github.com/open-telemetry/opentelemetry-collector-contrib/pull/12490)
- Add Building a Trace Receiver reference to collector When adding a new component section (#5690)
- Add "Building Component" sub menu to Collector Docs which would contain Building a custom authenticator and Building a Trace Receiver
- Testable Examples in Go which may not be end-to-end and uses some dummy implementation (so e.g. a receiver that generates a gauge point every minute? or some sort of simple logging exporter?), that still showcases how to use the interface (Refer to https://github.com/open-telemetry/opentelemetry-collector/issues/5675#issuecomment-1206557809)
Modules where we would want to have testable examples: