Add Getting started documentation for otel-cpp sdk #942
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
ThomsonTan
reviewed
Aug 9, 2021
docs/public/sdk/GettingStarted.rst
Outdated
| - In-Memory Exporter: keeps the data in memory, useful for debugging. | ||
| - Jaeger Exporter: prepares and sends the collected telemetry data to a Jaeger backend via UDP and HTTP. | ||
| - Zipkin Exporter: prepares and sends the collected telemetry data to a Zipkin backend via the Zipkin APIs. | ||
| - Logging Exporter: saves the telemetry data into log streams |
There was a problem hiding this comment.
nit: ending .? The same for line 20.
There was a problem hiding this comment.
thanks, it was missing at few other places, fixed all.
Codecov Report
@@ Coverage Diff @@
## main #942 +/- ##
=======================================
Coverage 95.36% 95.36%
=======================================
Files 160 160
Lines 6780 6780
=======================================
Hits 6465 6465
Misses 315 315 |
ThomsonTan
reviewed
Aug 9, 2021
| opts.server_addr = "localhost"; | ||
| opts.server_port = 6831; | ||
| auto jaeger_udp_exporter = | ||
| std::unique_ptr<sdktrace::SpanExporter>(new opentelemetry::exporter::jaeger::JaegerExporter(opts)); |
There was a problem hiding this comment.
Add Jaeger HTTP example?
There was a problem hiding this comment.
Yes missed that. Added now.
ThomsonTan
reviewed
Aug 9, 2021
| .. code:: cpp | ||
|
|
||
| // simple processor | ||
| auto simple_processor = std::unique_ptr<sdktrace::SpanProcessor>( |
There was a problem hiding this comment.
List the full definition of stdtrace in the beginning may help the users who follow these example code?
There was a problem hiding this comment.
Good point. Added it at the beginning.
ThomsonTan
approved these changes
Aug 10, 2021
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Changes
Currently, the otel-cpp documentation ( https://opentelemetry-cpp.readthedocs.io/en/latest/ ) contains reference api documentation for both sdk and api and
Getting starteddoc for api. But theGetting starteddoc for sdk is missing.This PR adds the sdk doc. This is how the sdk doc looks like:
https://labhas-opentelemetry-cpp.readthedocs.io/en/latest/sdk/GettingStarted.html
For significant contributions please make sure you have completed the following items:
CHANGELOG.mdupdated for non-trivial changes