Skip to content

Commit

Permalink
[docs] Add component context to contributing guide (open-telemetry#12490
Browse files Browse the repository at this point in the history
)

* Add component context to contributing guide

Signed-off-by: Martin Hickey <[email protected]>

* Update after review

Review comments updated:
- open-telemetry#12490 (comment)
- open-telemetry#12490 (comment)

Signed-off-by: Martin Hickey <[email protected]>
  • Loading branch information
hickeyma committed Aug 8, 2022
1 parent 384e9be commit caf24b6
Showing 1 changed file with 7 additions and 3 deletions.
10 changes: 7 additions & 3 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -75,10 +75,14 @@ providing the following information:
* The configuration options your component will accept. This will help us understand what it does and have an idea of
how the implementation might look like.

Components comprise of exporters, extensions, receivers, and processors. The key criteria to implementing a component is to:

Any component (receiver, processor, exporter, or extension) needs to implement the interfaces defined on the [core
repository](https://github.com/open-telemetry/opentelemetry-collector). Familiarize yourself with the interface of the
component that you want to write, and use existing implementations as reference.
* Implement the [component.Component](https://pkg.go.dev/go.opentelemetry.io/collector/component#Component) interface
* Provide a configuration structure which defines the configuration of the component
* Provide the implementation which performs the component operation

Familiarize yourself with the interface of the component that you want to write, and use existing implementations as reference.
[Building a Trace Receiver](https://opentelemetry.io/docs/collector/trace-receiver/) tutorial provides a detailed example of building a component.

*NOTICE:* The Collector is in Beta stage and as such the interfaces may undergo breaking changes. Component creators
must be available to update or review their components when such changes happen, otherwise the component will be
Expand Down

0 comments on commit caf24b6

Please sign in to comment.