Add list of exporters that are recommended for SDK#284
Conversation
Based on previous discussion [1] this PR adds a recommendation to include exporters for several open-source protocols in language libraries. Addresses issue open-telemetry#6 [1] - open-telemetry#277 (comment)
| 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. |
There was a problem hiding this comment.
- Jaeger and Zipkin backends support multiple encodings and transports, e.g. thrift, json, proto, udp, http, grpc. Which makes this recommendation pretty broad. Is the SDK in each language expected to implement all of those? Or at minimum one of those?
- This recommendation only applies to OTel SDKs, not to any implementation of OTel API. Perhaps this file should be renamed and scoped differently, e.g.
sdk-guidelines.md
There was a problem hiding this comment.
@yurishkuro I added a note that exact list of protocol is to be defined and also replaced "language library" by "SDK" in a few relevant places.
I think we should keep the name of the file since it is not only about SDK but touches the API package as well.
tedsuo
left a comment
There was a problem hiding this comment.
I recommend that we merge this for now, then follow up later to discuss the clarifications that @yurishkuro suggests.
eefc47d to
10e99f8
Compare
|
Admins: for some reason I cannot merge PRs in this spec. I guess I should be able as an approver? If so please give the merge permission. |
|
I recommend that after merging we also include an In Memory exporter option, as this will help users write tests (we had something like this in OT, called |
|
@tigrannajaryan do you want to add "in memory" next to "Standard output (or logging)"? |
|
@yurishkuro @carlosalberto sure, let me add in-memory to the list. |
10e99f8 to
1807572
Compare
|
@yurishkuro @carlosalberto "in-memory" exported added. |
* Add list of exporters that are recommended for SDK Based on previous discussion [1] this PR adds a recommendation to include exporters for several open-source protocols in language libraries. Addresses issue open-telemetry#6 [1] - open-telemetry#277 (comment) * PR fixes
* Add list of exporters that are recommended for SDK Based on previous discussion [1] this PR adds a recommendation to include exporters for several open-source protocols in language libraries. Addresses issue open-telemetry#6 [1] - open-telemetry#277 (comment) * PR fixes
…ing to OTEP 220 (open-telemetry#284) Co-authored-by: Liudmila Molkova <limolkova@microsoft.com> Co-authored-by: Joao Grassi <joao.grassi@dynatrace.com>
Based on previous discussion [1] this PR adds a recommendation to include
exporters for several open-source protocols in language libraries.
Fixes #6
[1] - #277 (comment)