Skip to content

Commit

Permalink
Add list of exporters that are recommended for SDK
Browse files Browse the repository at this point in the history
Based on previous discussion [1] this PR adds a recommendation to include
exporters for several open-source protocols in language libraries.

[1] - open-telemetry#277 (comment)
  • Loading branch information
Tigran Najaryan committed Oct 3, 2019
1 parent 68f70ed commit 34f89ba
Showing 1 changed file with 9 additions and 1 deletion.
10 changes: 9 additions & 1 deletion specification/library-guidelines.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,15 @@ _Note to Language Library Authors:_ OpenTelemetry specification, API and SDK imp

4. Language library implementation must be clearly separated into wire protocol-independent parts that implement common logic (e.g. batching, tag enrichment by process information, etc.) and protocol-dependent telemetry exporters. Telemetry exporters must contain minimal functionality, thus enabling vendors to easily add support for their specific protocol.

5. Language library implementation should include an exporter for OpenTelemetry Protocol (when the protocol is specified and approved) and may include an exporter that writes to standard output (to use for debugging and testing). Vendor-specific exporters (exporters that implement vendor protocols) should not be included in language libraries and should be placed elsewhere (the exact approach for storing and maintaining vendor-specific exporters will be defined in the future).
5. Language library implementation should include the following exporters:
- Jaeger.
- Zipkin.
- OpenCensus.
- Prometheus.
- OpenTelemetry Protocol (when the protocol is specified and approved).
- Standard output to use for debugging and testing.

Other vendor-specific exporters (exporters that implement vendor protocols) should not be included in language libraries and should be placed elsewhere (the exact approach for storing and maintaining vendor-specific exporters will be defined in the future).

# Language Library Generic Design

Expand Down

0 comments on commit 34f89ba

Please sign in to comment.