Welcome to Spring Microservices in Action, Chapter 9. Chapter 9 demonstrates how to use Spring Cloud Sleuth. Spring Cloud Sleuth introduces tracing information into your service calls. The tracing information can be used in conjuction with a log aggregation tool (Papertrail) to query log messages by one piece of their tracing information (the correlation id). Also, we will be exploring how to do distributed tracing using Spring Cloud Sleuth and Zipkin.
By the time you are done reading this chapter you will have built and/or deployed:
- A Spring Cloud Config server that is deployed as Docker container and can manage a services configuration information using a file system or GitHub-based repository.
- A Eureka server running as a Spring-Cloud based service. This service will allow multiple service instances to register with it. Clients that need to call a service will use Eureka to lookup the physical location of the target service.
- A Zuul API Gateway. All of our microservices can be routed through the gateway and have pre, response and post policies enforced on the calls.
- A organization service that will manage organization data used within EagleEye.
- A new version of the organization service. This service is used to demonstrate how to use the Zuul API gateway to route to different versions of a service.
- A special routes services that the the API gateway will call to determine whether or not it should route a user's service call to a different service then the one they were originally calling. This service is used in conjunction with the orgservice-new service to determine whether a call to the organization service gets routed to an old version of the organization service vs. a new version of the service.
- A licensing service that will manage licensing data used within EagleEye.
- A Postgres SQL database used to hold the data for these two services.
- A Kafka message bus to transport messages between services.
- A Redis service to act as a distributed cache.
- [Apache Maven] (http://maven.apache.org). I used version 3.3.9 of the Maven. I chose Maven because, while other build tools like Gradle are extremely popular, Maven is still the pre-dominate build tool in use in the Java ecosystem. All of the code examples in this book have been compiled with Java version 1.8.
- [Docker] (http://docker.com). I built the code examples in this book using Docker V1.12 and above. I am taking advantage of the embedded DNS server in Docker that came out in release V1.11. New Docker releases are constantly coming out so it's release version you are using may change on a regular basis.
- [Git Client] (http://git-scm.com). All of the source code for this book is stored in a GitHub repository. For the book, I used version 2.8.4 of the git client.
To build the code examples for Chapter 9 as a docker image, open a command-line window change to the directory where you have downloaded the Chapter 9 source code.
Run the following maven command. This command will execute the Spotify docker plugin defined in the pom.xml file.
mvn clean package docker:build
Running the above command at the root of the project directory will build all of the projects. If everything builds successfully you should see a message indicating that the build was successful.
Now we are going to use docker-compose to start the actual image. To start the docker image, change to the directory containing your chapter 9 source code. Issue the following docker-compose command:
docker-compose -f docker/common/docker-compose.yml up
If everything starts correctly you should see a bunch of Spring Boot information fly by on standard out. At this point all of the services needed for the chapter code examples will be running.