Updating ReadMEs for Jaeger, Zipkin, OTLP exporters#1591
Updating ReadMEs for Jaeger, Zipkin, OTLP exporters#1591cijothomas merged 6 commits intoopen-telemetry:masterfrom Austin-Tan:UpdateReadMesBatchOptions
Conversation
| * `Headers`: Optional headers for the connection. | ||
| * `ChannelOptions`: gRPC channel options. | ||
| * `ExportProcessorType`: Whether the exporter should use | ||
| [Batch or Simple base exporter](https://github.com/open-telemetry/opentelemetry-dotnet/tree/master/src/OpenTelemetry#introduction) |
There was a problem hiding this comment.
There was a problem hiding this comment.
Ah I linked to the API intro where it mentioned those but this is a better, more guided and specific reference. Thanks I'll update it.
There was a problem hiding this comment.
Most of the time, linking to spec is right, as its our source of truth! For anything specific to .NET implementation (this repo), we should link to this repo itself.
Agree. We can have docs explain the concepts, and also explain options which requires some explanation. And then simply link to the actual class file for the full list of option. (Lets address this separately, as we need to do it for pretty much all instrumentation) |
Co-authored-by: Cijo Thomas <cithomas@microsoft.com>
2 participants
One thought: Does the ReadMe look too cluttered this way? We are listing every option available in configuring the exporter. The descriptions are brief, but it is still a bullet point of 5-ish entries each. @reyang @cijothomas @eddynaka please advise.
Changes
#1584 #1587 #1504 all added the batch exporter and exporter type properties. We include these in the ReadMEs.
#1557 and #1572 removed the ServiceName option from Otlp and Jaeger Exporters. We removed these from ReadMes.
For significant contributions please make sure you have completed the following items:
CHANGELOG.mdupdated for non-trivial changes