Skip to content

Commit

Permalink
Add guidelines for observability in the components (open-telemetry#2436)
Browse files Browse the repository at this point in the history
As part of open-telemetry#2430, this PR adds guidelines for component developers on how to appropriately make their components observable.

Signed-off-by: Juraci Paixão Kröhling <[email protected]>
  • Loading branch information
jpkrohling authored Apr 9, 2021
1 parent 8732172 commit 9c3d27f
Showing 1 changed file with 10 additions and 0 deletions.
10 changes: 10 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -246,6 +246,16 @@ the event happens.
Make log message human readable and also include data that is needed for easier
understanding of what happened and in what context.

### Observability

Out of the box, your users should be able to observe the state of your component.
The collector exposes an OpenMetrics endpoint at `http://localhost:8888/metrics`
where your data will land.

When using the regular helpers, you should have some metrics added around key
events automatically. For instance, exporters should have `otelcol_exporter_sent_spans`
tracked without your exporter doing anything.

### Resource Usage

Limit usage of CPU, RAM or other resources that the code can use. Do not write code
Expand Down

0 comments on commit 9c3d27f

Please sign in to comment.