From 9a46a0a06fc276e849148671308d49fc67095c30 Mon Sep 17 00:00:00 2001 From: Marcin Grzejszczak Date: Tue, 12 Jun 2018 15:29:11 +0200 Subject: [PATCH] Fixed typos in the docs --- README.adoc | 6 +++--- docs/src/main/asciidoc/intro.adoc | 2 +- docs/src/main/asciidoc/spring-cloud-sleuth.adoc | 10 ++++++---- 3 files changed, 10 insertions(+), 8 deletions(-) diff --git a/README.adoc b/README.adoc index 67fe123e8..6b6e5f088 100644 --- a/README.adoc +++ b/README.adoc @@ -80,7 +80,7 @@ of an action took place. Subtracting the `cs` timestamp from this timestamp reveals the network latency. * *ss*: Server Sent. Annotated upon completion of request processing (when the response got sent back to the client). Subtracting the `sr` timestamp from this timestamp reveals the time needed by the server side to process the request. -* *cr*> Client Received. Signifies the end of the span. +* *cr*: Client Received. Signifies the end of the span. The client has successfully received the response from the server side. Subtracting the `cs` timestamp from this timestamp reveals the whole time needed by the client to receive the response from the server. @@ -96,7 +96,7 @@ Trace Id = X Span Id = D Client Sent -This note indicates that the current span has *Trace Id* set to *X* and *Span Id* set to *D*. +This note indicats thatthe current span has *Trace Id* set to *X* and *Span Id* set to *D*. Also, the `Client Sent` event took place. The following image shows how parent-child relationships of spans look: @@ -741,4 +741,4 @@ added after the original pull request but before a merge. other target branch in the main project). * When writing a commit message please follow http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html[these conventions], if you are fixing an existing issue please add `Fixes gh-XXXX` at the end of the commit - message (where XXXX is the issue number). + message (where XXXX is the issue number). \ No newline at end of file diff --git a/docs/src/main/asciidoc/intro.adoc b/docs/src/main/asciidoc/intro.adoc index 902e99f15..ee1800536 100644 --- a/docs/src/main/asciidoc/intro.adoc +++ b/docs/src/main/asciidoc/intro.adoc @@ -33,7 +33,7 @@ of an action took place. Subtracting the `cs` timestamp from this timestamp reveals the network latency. * *ss*: Server Sent. Annotated upon completion of request processing (when the response got sent back to the client). Subtracting the `sr` timestamp from this timestamp reveals the time needed by the server side to process the request. -* *cr*> Client Received. Signifies the end of the span. +* *cr*: Client Received. Signifies the end of the span. The client has successfully received the response from the server side. Subtracting the `cs` timestamp from this timestamp reveals the whole time needed by the client to receive the response from the server. diff --git a/docs/src/main/asciidoc/spring-cloud-sleuth.adoc b/docs/src/main/asciidoc/spring-cloud-sleuth.adoc index 9212894eb..d223af956 100644 --- a/docs/src/main/asciidoc/spring-cloud-sleuth.adoc +++ b/docs/src/main/asciidoc/spring-cloud-sleuth.adoc @@ -25,6 +25,10 @@ IMPORTANT: Starting with version `2.0.0`, Spring Cloud Sleuth uses https://github.com/openzipkin/brave[Brave] as the tracing library. For your convenience, we embed part of the Brave's docs here. +IMPORTANT: In the vast majority of cases you need to just use the `Tracer` +or `SpanCustomizer` beans from Brave that Sleuth provides. The documentation below contains +a high overview of what Brave is and how it works. + // TODO: We should link, not include. We have no idea when that content will change and so no way to keep our copy current. I also have no idea what I should edit, because I don't know what is ours and what is Brave's. Brave is a library used to capture and report latency information about distributed operations to Zipkin. @@ -209,9 +213,7 @@ oneWayReceive.start().flush(); next = tracer.newSpan(oneWayReceive.context()).name("step2").start(); ``` -NOTE: The propagation logic shown in the preceding example is a simplified version of our [http handlers](https://github.com/openzipkin/sleuth/tree/master/instrumentation/http#http-server). - -You can find a working example of a one-way span [here](src/test/java/sleuth/features/async/OneWaySpanTest.java). +NOTE: The propagation logic shown in the preceding example is a simplified version of our https://github.com/openzipkin/sleuth/tree/master/instrumentation/http#http-server[http handlers]. == Sampling @@ -401,7 +403,7 @@ You can also use the `spring.sleuth.propagation-keys` property to pass a list of The `TraceContext.Extractor` reads trace identifiers and sampling status from an incoming request or message. The carrier is usually a request object or headers. -This utility is used in standard instrumentation (such as `[HttpServerHandler](../instrumentation/http/src/main/java/sleuth/http/HttpServerHandler.java)`) but can also be used for custom RPC or messaging code. +This utility is used in standard instrumentation (such as `HttpServerHandler``) but can also be used for custom RPC or messaging code. `TraceContextOrSamplingFlags` is usually used only with `Tracer.nextSpan(extracted)`, unless you are sharing span IDs between a client and a server.