From b435d0eef96b9cd985b0ef2c2a9ca19eda1ede42 Mon Sep 17 00:00:00 2001 From: Marcin Grzejszczak Date: Wed, 29 Jul 2020 09:06:54 +0200 Subject: [PATCH] Updated docs --- README.adoc | 1 + docs/src/main/asciidoc/features.adoc | 1 + docs/src/main/asciidoc/spring-cloud-sleuth.adoc | 9 ++++++--- 3 files changed, 8 insertions(+), 3 deletions(-) diff --git a/README.adoc b/README.adoc index ee1effd51..e6e013f85 100644 --- a/README.adoc +++ b/README.adoc @@ -164,6 +164,7 @@ including the count of calls and how many errors exist. The example application will make a simple diagram like this, but your real environment diagram may be more complex. + image::https://raw.githubusercontent.com/spring-cloud/spring-cloud-sleuth/{branch}/docs/src/main/asciidoc/images/zipkin-dependencies.png[Zipkin Dependencies] *Note*: Production environments will generate a lot of data. You will likely diff --git a/docs/src/main/asciidoc/features.adoc b/docs/src/main/asciidoc/features.adoc index d77b06e58..fc2da60de 100644 --- a/docs/src/main/asciidoc/features.adoc +++ b/docs/src/main/asciidoc/features.adoc @@ -60,6 +60,7 @@ including the count of calls and how many errors exist. The example application will make a simple diagram like this, but your real environment diagram may be more complex. + image::https://raw.githubusercontent.com/spring-cloud/spring-cloud-sleuth/{branch}/docs/src/main/asciidoc/images/zipkin-dependencies.png[Zipkin Dependencies] *Note*: Production environments will generate a lot of data. You will likely diff --git a/docs/src/main/asciidoc/spring-cloud-sleuth.adoc b/docs/src/main/asciidoc/spring-cloud-sleuth.adoc index 64aa235bf..63725e19b 100644 --- a/docs/src/main/asciidoc/spring-cloud-sleuth.adoc +++ b/docs/src/main/asciidoc/spring-cloud-sleuth.adoc @@ -58,13 +58,15 @@ That said, you might want to know more about how things work underneath. Here are some pointers. Here are the most core types you might use: + * `SpanCustomizer` - to change the span currently in progress * `Tracer` - to get a start new spans ad-hoc Here are the most relevant links from the OpenZipkin Brave project: -* [Brave's core library](https://github.com/openzipkin/brave/tree/master/brave) -* [Baggage (propagated fields)](https://github.com/openzipkin/brave/tree/master/brave#baggage) -* [HTTP tracing](https://github.com/openzipkin/brave/tree/master/instrumentation/http) + +* https://github.com/openzipkin/brave/tree/master/brave[Brave's core library] +* https://github.com/openzipkin/brave/tree/master/brave#baggage[Baggage (propagated fields)] +* https://github.com/openzipkin/brave/tree/master/instrumentation/http[HTTP tracing] == Sampling @@ -111,6 +113,7 @@ If you want to add the baggage entries as tags, to make it possible to search fo If you need to do anything more advanced than above, do not define properties and instead use a `@Bean` config for the baggage fields you use. + * `BaggagePropagationCustomizer` sets up baggage fields * Add a `SingleBaggageField` to control header names for a `BaggageField`. * `CorrelationScopeCustomizer` sets up MDC fields