-
Notifications
You must be signed in to change notification settings - Fork 559
Add OTLP exporter README #299
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
6 commits
Select commit
Hold shift + click to select a range
cf041fb
Add exporter readme
nadiaciobanu 19aa0d0
Fix newlines
nadiaciobanu 7cb8dd8
Address review comments
nadiaciobanu 147e904
Merge branch 'master' into otlp-readme
nadiaciobanu 3a79b20
Example formatting change
nadiaciobanu 23832bf
Update example
nadiaciobanu File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or 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
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,27 @@ | ||
| # OTLP Exporter | ||
|
|
||
| The [OpenTelemetry Protocol](https://github.com/open-telemetry/opentelemetry-specification/blob/master/specification/protocol/README.md) (OTLP) is a vendor-agnostic protocol designed as part of the OpenTelemetry project. The OTLP exporter can be used to export to any backend that supports OTLP. | ||
|
|
||
| The [OpenTelemetry Collector](https://github.com/open-telemetry/opentelemetry-collector) is a reference implementation of an OTLP backend. The Collector can be configured to export to many other backends, such as Zipkin and Jaegar. | ||
|
|
||
| For a full list of backends supported by the Collector, see the [main Collector repo](https://github.com/open-telemetry/opentelemetry-collector/tree/master/exporter) and [Collector contributions](https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/master/exporter). | ||
|
|
||
| ## Configuration | ||
|
|
||
| The OTLP exporter offers some configuration options. To configure the exporter, create an `OtlpExporterOptions` struct (defined in [exporter.h](include/exporter.h)), set the options inside, and pass the struct to the `OtlpExporter` constructor, like so: | ||
|
|
||
| ``` | ||
| OtlpExporterOptions options; | ||
| options.endpoint = "localhost:12345"; | ||
| auto exporter = std::unique_ptr<sdktrace::SpanExporter>(new otlp::OtlpExporter(options)); | ||
| ``` | ||
|
|
||
| ### Configuration options | ||
|
|
||
| | Option | Default | | ||
| | ------------ |------------------ | | ||
| | `endpoint` | `localhost:55680` | | ||
|
|
||
| ## Example | ||
|
|
||
| For a complete example demonstrating how to use the OTLP exporter, see [examples/otlp](../../examples/otlp). | ||
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.
Uh oh!
There was an error while loading. Please reload this page.