Spring Boot Project with External Tomcat for Observable Tracing¶

Introduction¶

Different enterprises use different technology stacks when building their enterprise-level frameworks within the Java ecosystem. For example, some companies use Spring Boot + Spring Cloud, while others use Spring Boot + Dubbo.
Guance supports various APM tools to integrate microservice tracing into Guance. You can choose the appropriate APM tool based on your needs.

Typically, microservices are run as JAR files. This article focuses on how to build these microservices into WAR packages and deploy them on Tomcat, and then integrate the tracing data into Guance. If it is a traditional WAR package project, the integration method is the same.

SkyWalking Scenario¶

Prerequisites¶

• Cloud server (CentOS 7.9)
• Install JDK
• Install Zookeeper
• Guance account
• Two Tomcat instances deployed at /usr/local/df-demo/tomcat8080 and /usr/local/df-demo/tomcat8081
• The cloud server has <DataKit installed>

Steps¶

1 Configure DataKit¶

1.1 Modify http_api (Optional)¶

Edit the /usr/local/datakit/conf.d/datakit.conf file and change the http_api listen value to 0.0.0.0:9529 to ensure that other hosts can access port 9529 on this host.
If you do not want other hosts to access DataKit, you can skip this step.

1.2 Enable SkyWalking Collector¶

Log in to the host, copy the sample file, and enable the SkyWalking collector.

cd /usr/local/datakit/conf.d/skywalking
cp skywalking.conf.sample skywalking.conf

Restart DataKit.

systemctl restart datakit

2 APM Integration¶

2.1 Download SkyWalking¶

Download apache-skywalking-java-agent-8.11.0, extract it, and rename the folder to agent. Upload it to the directories /usr/local/df-demo/tomcat8080 and /usr/local/df-demo/tomcat8081 on the host.

2.2 Configure Tomcat¶

Modify the /usr/local/df-demo/tomcat8080/bin/catalina.sh file and add the following content:

export CATALINA_OPTS="$CATALINA_OPTS -javaagent:/usr/local/df-demo/tomcat8080/agent/skywalking-agent.jar -Dskywalking.agent.service_name=tomcat-customer -Dskywalking.collector.backend_service=localhost:11800"

Parameter descriptions:

• -Dskywalking.agent.service_name: Service name
• -Dskywalking.collector.backend_service: DataKit address + SkyWalking collector port for trace reporting

Modify the /usr/local/df-demo/tomcat8081/bin/catalina.sh file and add the following content:

export CATALINA_OPTS="$CATALINA_OPTS -javaagent:/usr/local/df-demo/tomcat8081/agent/skywalking-agent.jar -Dskywalking.agent.service_name=tomcat-provider -Dskywalking.collector.backend_service=localhost:11800"

Start Tomcat.

cd /usr/local/df-demo/tomcat8080/bin
./startup.sh
cd /usr/local/df-demo/tomcat8081/bin
./startup.sh

2.3 Deploy Projects¶

Download the WAR packages and obtain consumer.war and provider.war from the skywalking directory.

• Place provider.war in the /usr/local/df-demo/tomcat8081/webapps directory.
• Place consumer.war in the /usr/local/df-demo/tomcat8080/webapps directory.

3 Observable Tracing¶

Access http://192.168.0.100:8080/consumer/ping in your browser, where the IP is the address of the host.
Log in to 「Guance」-「APM」, and you should see the tomcat-customer and tomcat-provider services.
Click on a trace to view flame graphs, span lists, call relationships, etc.