go/opentelemetry-go
go/opentelemetry-go
1
0
Fork 0
mirror of https://github.com/open-telemetry/opentelemetry-go.git synced 2025-01-20 03:30:02 +02:00
Code Issues Releases Activity

Split OTLP README to own directory

Browse Source
This commit is contained in:
wtong98 2020-06-01 13:27:23 -05:00
parent de094be4fc
commit 70d737b128
2 changed files with 80 additions and 81 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

81
example/README.md
View File

@ -1,85 +1,4 @@
# Example
Here is a collection of OpenTelemtry-Go examples showcasing basic functionality.
## OTLP
This example demonstrates how to export trace and metric data from an
application using OpenTelemetry's own wire protocal
[OTLP](https://github.com/open-telemetry/opentelemetry-specification/blob/master/specification/protocol/README.md).
We will also walk you through configuring a collector to accept OTLP exports.
### How to run?
#### Prequisites
- go >=1.14 installed
- OpenTelemetry collector is available
#### Start the Application
An example application is included in `example/otlp`. It simulates the process
of scribing a spell scroll (e.g. in [D&D](https://roll20.net/compendium/dnd5e/Spell%20Scroll#content)).
The application has been instrumented and exports both trace and metric data
via OTLP to any listening receiver. To run it:
```sh
go get -d go.opentelemetry.io/otel
cd $GOPATH/go.opentelemetry.io/otel/example/otlp
go run main.go
```
The application is currently configured to transmit exported data to
`localhost:55680`. See [main.go](otlp/main.go) for full details.
Note, if the receiver is incorrectly configured to take in metric data, the
application may complain about being unable to connect.
#### Configure the Collector
Follow the instructions [on the
website](https://opentelemetry.io/docs/collector/about/) to install a working
instance of the collector. This example assumes you have the collector installed
locally.
To configure the collector to accept OTLP traffic from our application,
ensure that it has the following configs:
```yaml
receivers:
otlp:
endpoint: 0.0.0.0:55680 # listens to localhost:55680
# potentially other receivers
service:
pipelines:
traces:
receivers:
- otlp
# potentially other receivers
processors: # whatever processors you need
exporters: # wherever you want your data to go
metrics:
receivers:
-otlp
# potentially other receivers
processors: etc
exporters: etc
# other services
```
An example config has been provided at
[example-otlp-config.yaml](otlp/example-otlp-config.yaml).
Then to run:
```sh
./[YOUR_COLLECTOR_BINARY] --config [PATH_TO_CONFIG]
```
If you use the example config, it's set to export to `stdout`. If you run
the collector on the same machine as the example application, you should
see trace and metric outputs from the collector.
## HTTP
This is a simple example that demonstrates tracing http request from client to server. The example

80
example/otlp/README.md Normal file
View File

@ -0,0 +1,80 @@
# OTLP Example
This example demonstrates how to export trace and metric data from an
application using OpenTelemetry's own wire protocal
[OTLP](https://github.com/open-telemetry/opentelemetry-specification/blob/master/specification/protocol/README.md).
We will also walk you through configuring a collector to accept OTLP exports.
### How to run?
#### Prequisites
- go >=1.14 installed
- OpenTelemetry collector is available
#### Configure the Collector
Follow the instructions [on the
website](https://opentelemetry.io/docs/collector/about/) to install a working
instance of the collector. This example assumes you have the collector installed
locally.
To configure the collector to accept OTLP traffic from our application,
ensure that it has the following configs:
```yaml
receivers:
otlp:
endpoint: 0.0.0.0:55680 # listens to localhost:55680
# potentially other receivers
service:
pipelines:
traces:
receivers:
- otlp
# potentially other receivers
processors: # whatever processors you need
exporters: # wherever you want your data to go
metrics:
receivers:
-otlp
# potentially other receivers
processors: etc
exporters: etc
# other services
```
An example config has been provided at
[example-otlp-config.yaml](otlp/example-otlp-config.yaml).
Then to run:
```sh
./[YOUR_COLLECTOR_BINARY] --config [PATH_TO_CONFIG]
```
If you use the example config, it's set to export to `stdout`. If you run
the collector on the same machine as the example application, you should
see trace and metric outputs from the collector.
#### Start the Application
An example application is included in this directory. It simulates the process
of scribing a spell scroll (e.g. in [D&D](https://roll20.net/compendium/dnd5e/Spell%20Scroll#content)).
The application has been instrumented and exports both trace and metric data
via OTLP to any listening receiver. To run it:
```sh
go get -d go.opentelemetry.io/otel
cd $GOPATH/go.opentelemetry.io/otel/example/otlp
go run main.go
```
The application is currently configured to transmit exported data to
`localhost:55680`. See [main.go](otlp/main.go) for full details.
After starting the application, you should see trace and metric log output
on the collector.
Note, if the receiver is incorrectly configured to take in metric data, the
application may complain about being unable to connect.