Skip to content
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

Verify and update OTLP trace exporter documentation #2053

Merged
merged 32 commits into from Sep 2, 2021
Merged
Changes from 6 commits
Commits
Show all changes
32 commits
Select commit Hold shift + click to select a range
cae7a4c
Inventory the documentation for and examples of the OTLP exporter.
Submarinee Jul 3, 2021
604068f
Merge remote-tracking branch 'origin/main' into otelgo
Submarinee Jul 3, 2021
cb6825c
modify the documentation for otlptrace exporter.
Submarinee Jul 6, 2021
d071601
Update exporters/otlp/otlptrace/README.md
Submarinee Jul 7, 2021
f228643
Update exporters/otlp/otlptrace/README.md
Submarinee Jul 7, 2021
c2699ab
Merge branch 'main' into main
Submarinee Jul 8, 2021
f21d279
Merge branch 'open-telemetry:main' into main
Submarinee Jul 25, 2021
cd897ea
Update exporters/otlp/otlptrace/README.md
Submarinee Jul 25, 2021
e3edec9
Update exporters/otlp/otlptrace/README.md
Submarinee Jul 25, 2021
5608a4a
Update exporters/otlp/otlptrace/README.md
Submarinee Jul 25, 2021
1b02def
add otlptrace example_test.go
Submarinee Jul 25, 2021
af8e6ab
modify the documentation for otlptrace exporter.
Submarinee Jul 25, 2021
4f1cd37
modify the documentation for otlptrace exporter.
Submarinee Jul 25, 2021
e42228a
Merge remote-tracking branch 'otelgo/main' into otlpmetric
Submarinee Jul 25, 2021
2ac7886
Update exporters/otlp/otlptrace/example_test.go
Submarinee Jul 30, 2021
f6dea98
Update exporters/otlp/otlptrace/example_test.go
Submarinee Jul 30, 2021
b594d45
Update exporters/otlp/otlptrace/example_test.go
Submarinee Jul 30, 2021
6ccfb2c
Update exporters/otlp/otlptrace/README.md
Submarinee Jul 30, 2021
8f471b0
Merge branch 'open-telemetry:main' into main
Submarinee Jul 30, 2021
1d274e4
Update exporters/otlp/otlptrace/README.md
Submarinee Jul 30, 2021
6061d42
modify the documentation for otlptrace exporter.
Submarinee Jul 30, 2021
c437e21
Update exporters/otlp/otlptrace/README.md
Submarinee Jul 30, 2021
7ef6815
Update exporters/otlp/otlptrace/README.md
Submarinee Jul 30, 2021
50cfeac
Update exporters/otlp/otlptrace/README.md
Submarinee Jul 30, 2021
1e4b69b
Update exporters/otlp/otlptrace/README.md
Submarinee Aug 19, 2021
5359244
Update exporters/otlp/otlptrace/README.md
Submarinee Aug 19, 2021
bf334b0
Update exporters/otlp/otlptrace/README.md
Submarinee Aug 19, 2021
6df0c51
Move example to otlptracehttp package
MrAlias Sep 2, 2021
1fb0f70
Unexport example functions
MrAlias Sep 2, 2021
aef81d7
Fix markdownlint errors
MrAlias Sep 2, 2021
7201c27
Specify payload types in README
MrAlias Sep 2, 2021
a0035bc
Merge branch 'main' into main
MrAlias Sep 2, 2021
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
30 changes: 30 additions & 0 deletions exporters/otlp/otlptrace/README.md
@@ -0,0 +1,30 @@
# OpenTelemetry-Go OTLP Span Exporter

Submarinee marked this conversation as resolved.
Show resolved Hide resolved
OpenTelemetry Protocol (OTLP) Span Exporter.
Submarinee marked this conversation as resolved.
Show resolved Hide resolved

To constructs a new Otlptrace Exporter and starts it:

```
exp, err := otlptrace.New(ctx, opts...)
```
pellared marked this conversation as resolved.
Show resolved Hide resolved

## Installation

```
go get -u go.opentelemetry.io/otel/exporters/otlp/otlptrace
```
pellared marked this conversation as resolved.
Show resolved Hide resolved

## [`otlptrace`](https://pkg.go.dev/go.opentelemetry.io/otel/exporters/otlp/otlptrace)

`otlptrace` package implements a span exporter that uses a `otlptrace.Client` interface.

`otlptrace.Client` manages connections to the collector, handles the transformation of data into wire format,
and the transmission of that data to the collector.
Submarinee marked this conversation as resolved.
Show resolved Hide resolved

## [`otlptracegrpc`](https://pkg.go.dev/go.opentelemetry.io/otel/exporters/otlp/otlptrace/otlptracegrpc)

The `otlptracegrpc` package implements a gRPC span exporter.
Submarinee marked this conversation as resolved.
Show resolved Hide resolved

## [`otlptracehttp`](https://pkg.go.dev/go.opentelemetry.io/otel/exporters/otlp/otlptrace/otlptracehttp)

The `otlptracehttp` package implements a HTTP span exporter.
Submarinee marked this conversation as resolved.
Show resolved Hide resolved