Skip to content

Commit

Permalink
Corrections to the Trace exporter README (#51)
Browse files Browse the repository at this point in the history
  • Loading branch information
dancalvert-google committed Jun 24, 2020
1 parent 8c1bbc5 commit 22d058f
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions exporter/trace/README.md
Expand Up @@ -3,22 +3,22 @@
[![Docs](https://godoc.org/github.com/GoogleCloudPlatform/opentelemetry-operations-go/exporter/trace?status.svg)](https://pkg.go.dev/github.com/GoogleCloudPlatform/opentelemetry-operations-go/exporter/trace)
[![Apache License][license-image]][license-url]

OpenTelemetry Google Cloud Trace Exporter allow the user to send collected traces and spans to Google Cloud.
OpenTelemetry Google Cloud Trace Exporter allows the user to send collected traces and spans to Google Cloud.

[Google Cloud Trace](https://cloud.google.com/trace) is a distributed tracing backend system. It helps developers to gather timing data needed to troubleshoot latency problems in microservice & monolithic architectures. It manages both the collection and lookup of gathered trace data.

This exporter package assumes your application is [already instrumented](https://github.com/open-telemetry/opentelemetry-go/blob/master/example/http/client/client.go) with the OpenTelemetry SDK. Once you get ready to export OpenTelemetry data, you can add this exporter to your application.

## Setup

Google Cloud Trace is a managed service provided by Google Cloud Platform. The end-to-end set up guide with OpenTelemetry is available on [the office document](https://cloud.google.com/trace/docs/setup/go-ot), so this document go through the exporter set up.
Google Cloud Trace is a managed service provided by Google Cloud Platform. The end-to-end set up guide with OpenTelemetry is available on [the official GCP docs](https://cloud.google.com/trace/docs/setup/go-ot), so this document goes through the exporter set up.

## Usage

Add `github.com/GoogleCloudPlatform/opentelemetry-operations-go/exporter/trace` to the import list and set up `go.mod` file accordingly.

```go
import texpoter "github.com/GoogleCloudPlatform/opentelemetry-operations-go/exporter/trace"
import texporter "github.com/GoogleCloudPlatform/opentelemetry-operations-go/exporter/trace"
```

Once you import the trace exporter package, then register the exporter to the application, and start tracing. If you are running in a GCP environment, the exporter will automatically authenticate using the environment's service account. If not, you will need to follow the instruction in [Authentication](#Authentication).
Expand Down Expand Up @@ -67,4 +67,4 @@ The Google Cloud Trace exporter depends upon [`google.FindDefaultCredentials`](h
* Learn more about Google Cloud Trace at https://cloud.google.com/trace

[license-url]: https://github.com/GoogleCloudPlatform/opentelemetry-operations-go/blob/master/LICENSE
[license-image]: https://img.shields.io/badge/license-Apache_2.0-green.svg?style=flat
[license-image]: https://img.shields.io/badge/license-Apache_2.0-green.svg?style=flat

0 comments on commit 22d058f

Please sign in to comment.