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

Updated docs about forcing means of sending spans to zipkin; fixes gh-862

Browse Source
This commit is contained in:
Marcin Grzejszczak
2018-02-15 12:31:11 +01:00
parent 20891321a3
commit 3224cc6b38
3 changed files with 22 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
README.adoc
View File

@@ -553,7 +553,7 @@ a baggage element then it will be sent downstream either via HTTP or messaging t
* Provides simple metrics of accepted / dropped spans.
* If `spring-cloud-sleuth-zipkin` then the app will generate and collect Zipkin-compatible traces.
* If `spring-cloud-sleuth-zipkin` is on the classpath then the app will generate and collect Zipkin-compatible traces.
By default it sends them via HTTP to a Zipkin server on localhost (port 9411).
Configure the location of the service using `spring.zipkin.baseUrl`.
- If you depend on `spring-rabbit` or `spring-kafka` your app will send traces to a broker instead of http.

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

@@ -41,7 +41,7 @@ a baggage element then it will be sent downstream either via HTTP or messaging t
* Provides simple metrics of accepted / dropped spans.
* If `spring-cloud-sleuth-zipkin` then the app will generate and collect Zipkin-compatible traces.
* If `spring-cloud-sleuth-zipkin` is on the classpath then the app will generate and collect Zipkin-compatible traces.
By default it sends them via HTTP to a Zipkin server on localhost (port 9411).
Configure the location of the service using `spring.zipkin.baseUrl`.
- If you depend on `spring-rabbit` or `spring-kafka` your app will send traces to a broker instead of http.

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

@@ -502,6 +502,11 @@ spring.zipkin.locator.discovery.enabled: true
== Sending spans to Zipkin
IMPORTANT: `spring-cloud-sleuth-stream` is deprecated and should no longer be used.
If `spring-cloud-sleuth-zipkin` is on the classpath then the app will generate and collect Zipkin-compatible traces.
By default it sends them via HTTP to a Zipkin server on localhost (port 9411). If you depend
on `spring-rabbit` or `spring-kafka` your app will send traces to a broker instead of http.
By default if you add `spring-cloud-starter-zipkin` as a dependency to your project,
when the span is closed, it will be sent to Zipkin over HTTP. The communication
is asynchronous. You can configure the URL by setting the `spring.zipkin.baseUrl`
@@ -520,6 +525,16 @@ Zipkin's service id inside the URL (example for `zipkinserver` service id)
spring.zipkin.baseUrl: http://zipkinserver/
----
If you have web, rabbit or kafka together on the classpath, you might need
to pick the means by which you would like to send spans to zipkin. To do that
just set either `web`, `rabbit` or `kafka` to the `spring.zipkin.sender.type` property.
Example for `web`:
[source,yaml]
----
spring.zipkin.sender.type: web
----
== Span Data as Messages
You can accumulate and send span data over
@@ -534,6 +549,11 @@ is called `sleuth`.
=== Zipkin Consumer
IMPORTANT: `spring-cloud-sleuth-zipkin-stream` is deprecated and should no longer be used.
Please use the OpenZipkin's Zipkin server and set the environment variables
as presented https://github.com/openzipkin/zipkin/tree/release-2.4.6/zipkin-collector/rabbitmq[here for rabbit (Zipkin 2.4.6)]
or https://github.com/openzipkin/zipkin/tree/release-2.4.6/zipkin-autoconfigure/collector-kafka10[here for kafka (Zipkin 2.4.6)]
There is a special convenience annotation for setting up a message consumer
for the Span data and pushing it into a Zipkin `SpanStore`. This application