31 lines
1.8 KiB
Markdown
31 lines
1.8 KiB
Markdown
|
[](https://circleci.com/gh/DataDog/dd-trace-go/tree/v1)
|
||
|
|
[](https://godoc.org/gopkg.in/DataDog/dd-trace-go.v1/ddtrace)
|
||
|
|
|
||
|
|
### Installing
|
||
|
|
|
||
|
|
```bash
|
||
|
|
go get gopkg.in/DataDog/dd-trace-go.v1/ddtrace
|
||
|
|
```
|
||
|
|
|
||
|
|
Requires:
|
||
|
|
|
||
|
|
* Go 1.9
|
||
|
|
* Datadog's Trace Agent >= 5.21.1
|
||
|
|
|
||
|
|
### Documentation
|
||
|
|
|
||
|
|
The API is documented on [godoc](https://godoc.org/gopkg.in/DataDog/dd-trace-go.v1/ddtrace) as well as Datadog's [official documentation](https://docs.datadoghq.com/tracing/setup/go/). If you are migrating
|
||
|
|
from an older version of the tracer (e.g. 0.6.x) you may also find the [migration document](https://github.com/DataDog/dd-trace-go/blob/v1/MIGRATING.md) we've put together helpful.
|
||
|
|
|
||
|
|
### Testing
|
||
|
|
|
||
|
|
Tests can be run locally using the Go toolset. The grpc.v12 integration will fail (and this is normal), because it covers for deprecated methods. In the CI environment
|
||
|
|
we vendor this version of the library inside the integration. Under normal circumstances this is not something that we want to do, because users using this integration
|
||
|
|
might be running versions different from the vendored one, creating hard to debug conflicts.
|
||
|
|
|
||
|
|
To run integration tests locally, you should set the `INTEGRATION` environment variable. The dependencies of the integration tests are best run via Docker. To get an
|
||
|
|
idea about the versions and the set-up take a look at our [CI config](https://github.com/DataDog/dd-trace-go/blob/v1/.circleci/config.yml).
|
||
|
|
|
||
|
|
The best way to run the entire test suite is using the [CircleCI CLI](https://circleci.com/docs/2.0/local-jobs/). Simply run `circleci build`
|
||
|
|
in the repository root. Note that you might have to increase the resources dedicated to Docker to around 4GB.
|