diff --git a/1.2.x/spring-cloud-sleuth.xml b/1.2.x/spring-cloud-sleuth.xml index 1b0bf1a3f..68f7ed76f 100644 --- a/1.2.x/spring-cloud-sleuth.xml +++ b/1.2.x/spring-cloud-sleuth.xml @@ -18,10 +18,10 @@ Introduction -Spring Cloud Sleuth implements a distributed tracing solution for Spring Cloud. +Spring Cloud Sleuth implements a distributed tracing solution for Spring Cloud.
Terminology -Spring Cloud Sleuth borrows Dapper’s terminology. +Spring Cloud Sleuth borrows Dapper’s terminology. Span: The basic unit of work. For example, sending an RPC is a new span, as is sending a response to an RPC. Span’s are identified by a unique 64-bit ID for the span and another 64-bit ID for the trace the span is a part of. Spans also have other data, such as descriptions, timestamped events, key-value @@ -200,7 +200,7 @@ service4.log:2016-02-26 11:15:48.134 INFO [service4,2485ec27856c56f4,1b1845262f service2.log:2016-02-26 11:15:48.156 INFO [service2,2485ec27856c56f4,9aa10ee6fbde75fa,true] 68059 --- [nio-8082-exec-1] i.s.c.sleuth.docs.service2.Application : Got response from service4 [Hello from service4] service1.log:2016-02-26 11:15:48.182 INFO [service1,2485ec27856c56f4,2485ec27856c56f4,true] 68058 --- [nio-8081-exec-1] i.s.c.sleuth.docs.service1.Application : Got response from service2 [Hello from service2, response from service3 [Hello from service3] and from service4 [Hello from service4]] If you’re using a log aggregating tool like Kibana, -Splunk etc. you can order the events that took place. An example of +Splunk etc. you can order the events that took place. An example of Kibana would look like this: @@ -1392,7 +1392,7 @@ Stream based span reporting). Span Data as Messages You can accumulate and send span data over -Spring Cloud Stream by +Spring Cloud Stream by including the spring-cloud-sleuth-stream jar as a dependency, and adding a Channel Binder implementation (e.g. spring-cloud-starter-stream-rabbit for RabbitMQ or @@ -1485,7 +1485,7 @@ public static class CustomPollerConfiguration { Metrics Currently Spring Cloud Sleuth registers very simple metrics related to spans. -It’s using the Spring Boot’s metrics support +It’s using the Spring Boot’s metrics support to calculate the number of accepted and dropped spans. Each time a span gets sent to Zipkin the number of accepted spans will increase. If there’s an error then the number of dropped spans will get increased. @@ -1674,7 +1674,7 @@ static class Config {
Traverson -If you’re using the Traverson library +If you’re using the Traverson library it’s enough for you to inject a RestTemplate as a bean into your Traverson object. Since RestTemplate is already intercepted, you will get full support of tracing in your client. Below you can find a pseudo code of how to do that: @@ -1773,7 +1773,7 @@ static class CustomExecutorConfig extends AsyncConfigurerSupport {
Messaging -Spring Cloud Sleuth integrates with Spring Integration. It creates spans for publish and +Spring Cloud Sleuth integrates with Spring Integration. It creates spans for publish and subscribe events. To disable Spring Integration instrumentation, set spring.sleuth.integration.enabled to false. You can provide the spring.sleuth.integration.patterns pattern to explicitly provide the names of channels that you want to include for tracing. By default all channels @@ -1794,10 +1794,10 @@ To disable Zuul support set the spring.sleuth.zuul.enabled pr You can find the running examples deployed in the Pivotal Web Services. Check them out in the following links: -Zipkin for apps presented in the samples to the top +Zipkin for apps presented in the samples to the top -Zipkin for Brewery on PWS, its Github Code +Zipkin for Brewery on PWS, its Github Code diff --git a/2.0.x/checkstyle-checker.xml b/2.0.x/checkstyle-checker.xml index 79233ddbd..ce80589e3 100644 --- a/2.0.x/checkstyle-checker.xml +++ b/2.0.x/checkstyle-checker.xml @@ -1,7 +1,7 @@ + "https://www.puppycrawl.com/dtds/configuration_1_3.dtd"> diff --git a/checkstyle-checker.xml b/checkstyle-checker.xml index 1ab895ffb..19e99953b 100644 --- a/checkstyle-checker.xml +++ b/checkstyle-checker.xml @@ -1,7 +1,7 @@ + "https://www.puppycrawl.com/dtds/configuration_1_3.dtd"> diff --git a/font-awesome/font/fontawesome-webfont.svg b/font-awesome/font/fontawesome-webfont.svg index 2edb4ec34..8b349d50e 100755 --- a/font-awesome/font/fontawesome-webfont.svg +++ b/font-awesome/font/fontawesome-webfont.svg @@ -1,5 +1,5 @@ - + diff --git a/spring-cloud-sleuth.xml b/spring-cloud-sleuth.xml index 87ee0b912..3b7a51394 100644 --- a/spring-cloud-sleuth.xml +++ b/spring-cloud-sleuth.xml @@ -18,10 +18,10 @@ Introduction -Spring Cloud Sleuth implements a distributed tracing solution for Spring Cloud. +Spring Cloud Sleuth implements a distributed tracing solution for Spring Cloud.
Terminology -Spring Cloud Sleuth borrows Dapper’s terminology. +Spring Cloud Sleuth borrows Dapper’s terminology. Span: The basic unit of work. For example, sending an RPC is a new span, as is sending a response to an RPC. Spans are identified by a unique 64-bit ID for the span and another 64-bit ID for the trace the span is a part of. Spans also have other data, such as descriptions, timestamped events, key-value annotations (tags), the ID of the span that caused them, and process IDs (normally IP addresses). @@ -183,7 +183,7 @@ However, if you want to use the legacy Sleuth approaches, you can set the Zipkin deployed on Pivotal Web Services -Click here to see it live! +Click here to see it live! The dependency graph in Zipkin should resemble the following image: @@ -202,7 +202,7 @@ However, if you want to use the legacy Sleuth approaches, you can set the Zipkin deployed on Pivotal Web Services -Click here to see it live! +Click here to see it live!
Log correlation @@ -214,7 +214,7 @@ service2.log:2016-02-26 11:15:47.924 INFO [service2,2485ec27856c56f4,9aa10ee6fb service4.log:2016-02-26 11:15:48.134 INFO [service4,2485ec27856c56f4,1b1845262ffba49d,true] 68061 --- [nio-8084-exec-1] i.s.c.sleuth.docs.service4.Application : Hello from service4 service2.log:2016-02-26 11:15:48.156 INFO [service2,2485ec27856c56f4,9aa10ee6fbde75fa,true] 68059 --- [nio-8082-exec-1] i.s.c.sleuth.docs.service2.Application : Got response from service4 [Hello from service4] service1.log:2016-02-26 11:15:48.182 INFO [service1,2485ec27856c56f4,2485ec27856c56f4,true] 68058 --- [nio-8081-exec-1] i.s.c.sleuth.docs.service1.Application : Got response from service2 [Hello from service2, response from service3 [Hello from service3] and from service4 [Hello from service4]] -If you use a log aggregating tool (such as Kibana, Splunk, and others), you can order the events that took place. +If you use a log aggregating tool (such as Kibana, Splunk, and others), you can order the events that took place. An example from Kibana would resemble the following image: @@ -745,7 +745,7 @@ You can configure the location of the service by setting spring.zipkin. -Spring Cloud Sleuth is OpenTracing compatible. +Spring Cloud Sleuth is OpenTracing compatible. @@ -872,7 +872,7 @@ void userCode() {
RPC tracing -Check for instrumentation written here and Zipkin’s list before rolling your own RPC instrumentation. +Check for instrumentation written here and Zipkin’s list before rolling your own RPC instrumentation. RPC tracing is often done automatically by interceptors. Behind the scenes, they add tags and events that relate to their role in an RPC operation. The following example shows how to add a client span: @@ -1662,7 +1662,7 @@ If those are not set, we try to retrieve the host name from the network interfac By default, if you add spring-cloud-starter-zipkin as a dependency to your project, when the span is closed, it is sent to Zipkin over HTTP. The communication is asynchronous. You can configure the URL by setting the spring.zipkin.baseUrl property, as follows: -spring.zipkin.baseUrl: http://192.168.99.100:9411/ +spring.zipkin.baseUrl: https://192.168.99.100:9411/ If you want to find Zipkin through service discovery, you can pass the Zipkin’s service ID inside the URL, as shown in the following example for zipkinserver service ID: spring.zipkin.baseUrl: http://zipkinserver/ To disable this feature just set spring.zipkin.discoveryClientEnabled to `false. @@ -1705,13 +1705,13 @@ object, you will have to create a bean of zipkin2.reporter.Sender
-If for some reason you need to create the deprecated Stream Zipkin server, see the Dalston Documentation. +If for some reason you need to create the deprecated Stream Zipkin server, see the Dalston Documentation.
Integrations
OpenTracing -Spring Cloud Sleuth is compatible with OpenTracing. +Spring Cloud Sleuth is compatible with OpenTracing. If you have OpenTracing on the classpath, we automatically register the OpenTracing Tracer bean. If you wish to disable this, set spring.sleuth.opentracing.enabled to false
@@ -1917,7 +1917,7 @@ If you create a WebClient instance with a new
Traverson -If you use the Traverson library, you can inject a RestTemplate as a bean into your Traverson object. +If you use the Traverson library, you can inject a RestTemplate as a bean into your Traverson object. Since RestTemplate is already intercepted, you get full support for tracing in your client. The following pseudo code shows how to do that: @Autowired RestTemplate restTemplate; @@ -2092,7 +2092,7 @@ to add the @Role(BeanDefinition.ROLE_INFRASTRUCTURE) on your Features from this section can be disabled by setting the spring.sleuth.messaging.enabled property with value equal to false.
Spring Integration and Spring Cloud Stream -Spring Cloud Sleuth integrates with Spring Integration. +Spring Cloud Sleuth integrates with Spring Integration. It creates spans for publish and subscribe events. To disable Spring Integration instrumentation, set spring.sleuth.integration.enabled to false. You can provide the spring.sleuth.integration.patterns pattern to explicitly provide the names of channels that you want to include for tracing. @@ -2147,11 +2147,11 @@ To disable Zuul support, set the spring.sleuth.zuul.enabled p Check them out at the following links: -Zipkin for apps presented in the samples to the top. First make -a request to Service 1 and then check out the trace in Zipkin. +Zipkin for apps presented in the samples to the top. First make +a request to Service 1 and then check out the trace in Zipkin. -Zipkin for Brewery on PWS, its Github Code. +Zipkin for Brewery on PWS, its Github Code. Ensure that you’ve picked the lookback period of 7 days. If there are no traces, go to Presenting application and order some beers. Then check Zipkin for traces.