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>2020-05-08 21:34:06 +0200
committerGitHub <noreply@github.com>2020-05-08 21:34:06 +0200
commit7f8b31f5fb59d8b66a26dcd822863fbc18687905 (patch)
tree02ba6090ce80e17cb29d74feb44e43d5ff16090f /vendor/github.com/uber/jaeger-client-go/README.md
parentaa74c3f09223107b85b6538a1ffe1e359ff51a65 (diff)
parent5be55739ccf2435e96b52ca64ce1627506927069 (diff)
downloadpodman-7f8b31f5fb59d8b66a26dcd822863fbc18687905.tar.gz
podman-7f8b31f5fb59d8b66a26dcd822863fbc18687905.tar.bz2
podman-7f8b31f5fb59d8b66a26dcd822863fbc18687905.zip
Merge pull request #6049 from containers/dependabot/go_modules/github.com/uber/jaeger-client-go-2.23.1incompatible
build(deps): bump github.com/uber/jaeger-client-go from 2.22.1+incompatible to 2.23.1+incompatible
Diffstat (limited to 'vendor/github.com/uber/jaeger-client-go/README.md')
-rw-r--r--vendor/github.com/uber/jaeger-client-go/README.md22
1 files changed, 14 insertions, 8 deletions
diff --git a/vendor/github.com/uber/jaeger-client-go/README.md b/vendor/github.com/uber/jaeger-client-go/README.md
index 0e4d9fc0b..7c348e73a 100644
--- a/vendor/github.com/uber/jaeger-client-go/README.md
+++ b/vendor/github.com/uber/jaeger-client-go/README.md
@@ -87,7 +87,7 @@ defer closer.Close()
This is especially useful for command-line tools that enable tracing, as well as
for the long-running apps that support graceful shutdown. For example, if your deployment
system sends SIGTERM instead of killing the process and you trap that signal to do a graceful
-exit, then having `defer closer.Closer()` ensures that all buffered spans are flushed.
+exit, then having `defer closer.Close()` ensures that all buffered spans are flushed.
### Metrics & Monitoring
@@ -279,20 +279,25 @@ However it is not the default propagation format, see [here](zipkin/README.md#Ne
## 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.
+Jaeger Tracer supports an additional [span reference][] type call `Self`, which was proposed
+to the OpenTracing Specification (https://github.com/opentracing/specification/issues/81)
+but not yet accepted. This allows the caller to provide an already created `SpanContext`
+when starting a new span. The `Self` reference bypasses trace and span id generation,
+as well as sampling decisions (i.e. the sampling bit in the `SpanContext.flags` must be
+set appropriately by the caller).
+The `Self` reference supports the following use cases:
+ * the ability to provide externally generated trace and span IDs
+ * appending data to the same span from different processes, such as loading and continuing spans/traces from offline (ie log-based) storage
-Usage requires passing in a `SpanContext` and the jaeger `Self` reference type:
+Usage requires passing in a `SpanContext` and the `jaeger.Self` reference type:
```
span := tracer.StartSpan(
"continued_span",
- SelfRef(yourSpanContext),
+ jaeger.SelfRef(yourSpanContext),
)
...
-defer span.finish()
+defer span.Finish()
```
## License
@@ -310,3 +315,4 @@ defer span.finish()
[ot-url]: http://opentracing.io
[baggage]: https://github.com/opentracing/specification/blob/master/specification.md#set-a-baggage-item
[timeunits]: https://golang.org/pkg/time/#ParseDuration
+[span reference]: https://github.com/opentracing/specification/blob/1.1/specification.md#references-between-spans