1
0
mirror of https://github.com/open-telemetry/opentelemetry-go.git synced 2024-12-04 09:43:23 +02:00
opentelemetry-go/example/README.md
rghetia 15bfc5bb12
Namespace import path under "/otel" (#274)
Also fixes example module paths so that they use the vanity URL instead
of the github URL.

[Closes #184]
2019-11-01 11:40:29 -07:00

47 lines
1.1 KiB
Markdown

# Example
## HTTP
This is a simple example that demonstrates tracing http request from client to server. The example
shows key aspects of tracing such as:
- Root Span (on Client)
- Child Span (on Client)
- Child Span from a Remote Parent (on Server)
- SpanContext Propagation (from Client to Server)
- Span Events
- Span Attributes
Example uses
- open-telemetry SDK as trace instrumentation provider,
- httptrace plugin to facilitate tracing http request on client and server
- http trace_context propagation to propagate SpanContext on the wire.
- stdout exporter to print information about spans in the terminal
### How to run?
#### Prequisites
- go 1.13 installed
- GOPATH is configured.
#### 1 Download git repo
```
GO111MODULE="" go get -d go.opentelemetry.io/otel
```
#### 2 Start Server
```
cd $GOPATH/src/go.opentelemetry.io/otel/example/http/
go run ./server/server.go
```
#### 3 Start Client
```
cd $GOPATH/src/go.opentelemetry.io/otel/example/http/
go run ./client/client.go
```
#### 4 Check traces in stdout
The spans should be visible in stdout in the order that they were exported.