SpringCloud/spring-cloud-sleuth
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Fixed typos in the docs

Browse Source
This commit is contained in:
Marcin Grzejszczak
2018-06-12 15:29:11 +02:00
parent c0a0f3802f
commit 9a46a0a06f
3 changed files with 10 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
README.adoc
View File

@@ -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).

2
docs/src/main/asciidoc/intro.adoc
View File

@@ -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.

10
docs/src/main/asciidoc/spring-cloud-sleuth.adoc
View File

@@ -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<C>` 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.