summaryrefslogtreecommitdiff
path: root/vendor/github.com/uber/jaeger-client-go/README.md
diff options
context:
space:
mode:
authorOpenShift Merge Robot <openshift-merge-robot@users.noreply.github.com>2019-09-30 11:53:01 -0700
committerGitHub <noreply@github.com>2019-09-30 11:53:01 -0700
commit04b3a73635d8150138fab853ce8f2e6e60f6581d (patch)
treedbd35cb6a356029228ee880d3c18f7ad13c7e428 /vendor/github.com/uber/jaeger-client-go/README.md
parent79c18f134dbc985e6dce7bc88eea57a75b035c89 (diff)
parent2f397ecdeb1f5f064e30c3ab9bf85f5c10c41afa (diff)
downloadpodman-04b3a73635d8150138fab853ce8f2e6e60f6581d.tar.gz
podman-04b3a73635d8150138fab853ce8f2e6e60f6581d.tar.bz2
podman-04b3a73635d8150138fab853ce8f2e6e60f6581d.zip
Merge pull request #4145 from containers/dependabot/go_modules/github.com/uber/jaeger-client-go-2.19.0+incompatible
Bump github.com/uber/jaeger-client-go from 2.16.0+incompatible to 2.19.0+incompatible
Diffstat (limited to 'vendor/github.com/uber/jaeger-client-go/README.md')
-rw-r--r--vendor/github.com/uber/jaeger-client-go/README.md33
1 files changed, 26 insertions, 7 deletions
diff --git a/vendor/github.com/uber/jaeger-client-go/README.md b/vendor/github.com/uber/jaeger-client-go/README.md
index 6d9546e5b..604d4b571 100644
--- a/vendor/github.com/uber/jaeger-client-go/README.md
+++ b/vendor/github.com/uber/jaeger-client-go/README.md
@@ -3,7 +3,7 @@
# Jaeger Bindings for Go OpenTracing API
Instrumentation library that implements an
-[OpenTracing](http://opentracing.io) Tracer for Jaeger (https://jaegertracing.io).
+[OpenTracing Go](https://github.com/opentracing/opentracing-go) Tracer for Jaeger (https://jaegertracing.io).
**IMPORTANT**: The library's import path is based on its original location under `github.com/uber`. Do not try to import it as `github.com/jaegertracing`, it will not compile. We might revisit this in the next major release.
* :white_check_mark: `import "github.com/uber/jaeger-client-go"`
@@ -15,19 +15,20 @@ Please see [CONTRIBUTING.md](CONTRIBUTING.md).
## Installation
-We recommended using a dependency manager like [glide](https://github.com/Masterminds/glide)
+We recommended using a dependency manager like [dep](https://golang.github.io/dep/)
and [semantic versioning](http://semver.org/) when including this library into an application.
For example, Jaeger backend imports this library like this:
-```yaml
-- package: github.com/uber/jaeger-client-go
- version: ^2.7.0
+```toml
+[[constraint]]
+ name = "github.com/uber/jaeger-client-go"
+ version = "2.17"
```
If you instead want to use the latest version in `master`, you can pull it via `go get`.
Note that during `go get` you may see build errors due to incompatible dependencies, which is why
we recommend using semantic versions for dependencies. The error may be fixed by running
-`make install` (it will install `glide` if you don't have it):
+`make install` (it will install `dep` if you don't have it):
```shell
go get -u github.com/uber/jaeger-client-go/
@@ -222,7 +223,7 @@ import (
)
span := opentracing.SpanFromContext(ctx)
-ext.SamplingPriority.Set(span, 1)
+ext.SamplingPriority.Set(span, 1)
```
#### Via HTTP Headers
@@ -253,6 +254,24 @@ by a lot of Zipkin tracers. This means that you can use Jaeger in conjunction wi
However it is not the default propagation format, see [here](zipkin/README.md#NewZipkinB3HTTPHeaderPropagator) how to set it up.
+## SelfRef
+
+Jaeger Tracer supports an additional [reference](https://github.com/opentracing/specification/blob/1.1/specification.md#references-between-spans)
+type call `Self`. This allows a caller to provide an already established `SpanContext`.
+This allows loading and continuing spans/traces from offline (ie log-based) storage. The `Self` reference
+bypasses trace and span id generation.
+
+
+Usage requires passing in a `SpanContext` and the jaeger `Self` reference type:
+```
+span := tracer.StartSpan(
+ "continued_span",
+ SelfRef(yourSpanContext),
+)
+...
+defer span.finish()
+```
+
## License
[Apache 2.0 License](LICENSE).