PetClinic loadgen and RUM to APM

Author: rcastley

content/en/other/pet-clinic/_index.md

@@ -12,6 +12,7 @@ The goal is to walk through the basic steps to configure the following component
   * Database Query Performance
   * AlwaysOn Profiling
 * Splunk Real User Monitoring (RUM)
+* RUM spans to APM spans
 * Splunk LogsObserver (LO)
 
 We will also show the steps about how to clone (download) a sample Java application (Spring PetClinic), as well as how to compile, package and run the application.

content/en/other/pet-clinic/apm.md

@@ -14,14 +14,10 @@ Next we will clone the PetClinic repository, then we will compile, build, packag
 git clone https://github.com/spring-projects/spring-petclinic
 ```
 
-```bash
-git checkout 276880e
-```
-
 Change into the `spring-petclinic` directory:
 
 ```bash
-cd spring-petclinic
+cd spring-petclinic && git checkout 276880e
 ```
 
 Start a MySQL database for PetClinic to use:
@@ -30,21 +26,21 @@ Start a MySQL database for PetClinic to use:
 docker run -d -e MYSQL_USER=petclinic -e MYSQL_PASSWORD=petclinic -e MYSQL_ROOT_PASSWORD=root -e MYSQL_DATABASE=petclinic -p 3306:3306 docker.io/mysql:5.7.8
 ```
 
-Next, run the maven command to compile/build/package PetClinic:
+Next, run the `maven` command to compile/build/package PetClinic:
 
 ```bash
 ./mvnw package -Dmaven.test.skip=true
 ```
 
-{{% notice title="Information" style="info" %}}
-This will take a few minutes the first time you run, maven will download a lot of dependencies before it actually compiles the app. Future executions will be a lot shorter.
+{{% notice title="Note" style="info" %}}
+This will take a few minutes the first time you run, `maven` will download a lot of dependencies before it actually compiles the application. Future executions will be a lot shorter.
 {{% /notice %}}
 
 Once the compilation is complete, you can run the application with the following command:
 
 ```bash
 java \
--Dotel.service.name=$(hostname)-petclinic.service \
+-Dotel.service.name=$(hostname)-petclinic-service \
 -jar target/spring-petclinic-*.jar --spring.profiles.active=mysql
 ```
 
@@ -54,37 +50,49 @@ If you check the logs of the Splunk OpenTelemetry collector you will see that th
 sudo tail -f /var/log/syslog
 ```
 
-You can validate if the application is running by visiting `http://<VM_IP_ADDRESS>:8080`. Now generate some traffic, click around, generate errors, add visits, etc. Then you can visit the Splunk APM UI and examine the application components, traces, etc. **Hamburger Menu → APM → Explore**.
+You can validate if the application is running by visiting `http://<VM_IP_ADDRESS>:8080`.
+
+## 2. Generating Traffic
+
+Next we will start a Docker container running Locust that will generate some simple traffic to the PetClinic application. Locust is a simple load testing tool that can be used to generate traffic to a web application.
+
+```bash
+docker run --network="host" -d -p 8089:8089 -v /home/ubuntu/workshop/locust:/mnt/locust locustio/locust -f /mnt/locust/locustfile.py --headless -u 10 -r 3 -H http://127.0.0.1:8080
+```
+
+Then you can visit the Splunk APM UI and examine the application components, traces, etc. **Hamburger Menu → APM → Explore**.
+
+Once your validation is complete you can stop the application by pressing `Ctrl-c`.
 
-**Once your validation is complete you can stop the application by pressing** `Ctrl-c` **.**
+## 3. Enabling AlwaysOn Profiling and Metrics
 
 To enable CPU and Memory Profiling on the application we can start the application by passing `splunk.profiler.enabled=true` and for metrics pass `splunk.metrics.enabled=true`. Make sure the application is stopped and run the following command to enable metrics and profiling.
 
 ```bash
 java \
--Dotel.service.name=$(hostname)-petclinic.service \
+-Dotel.service.name=$(hostname)-petclinic-service \
 -Dsplunk.profiler.enabled=true \
 -Dsplunk.metrics.enabled=true \
 -jar target/spring-petclinic-*.jar --spring.profiles.active=mysql
 ```
 
-Let's go visit our application again to generate some traffic `http://<VM_IP_ADDRESS>:8080`. Click around, generate errors, add visits, etc. Then you can visit the Splunk APM UI and examine the application components, traces, profiling, DB Query performance and metrics **Hamburger Menu → APM → Explore**.
+You can now visit the Splunk APM UI and examine the application components, traces, profiling, DB Query performance and metrics **Hamburger Menu → APM → Explore**.
 
-**Once your validation is complete you can stop the application by pressing** `Ctrl-c` **.**
+Once your validation is complete you can stop the application by pressing `Ctrl-c`.
 
-## 2. Adding Resource Attributes to Spans
+## 4. Adding Resource Attributes to Spans
 
 Resource attributes can be added to every reported span. For example `version=0.314`. A comma separated list of resource attributes can also be defined e.g. `key1=val1,key2=val2`.
 
 Let's launch the PetClinic again using a new resource attribute. Note, that adding resource attributes to the run command will override what was defined when we installed the collector. So, we also need to specify our `deployment.environment` resource attribute along with our new resource attribute. Below you will see we are setting `deployment.environment=$(hostname)-petclinic` and `version=0.314`.
 
 ```bash
 java \
--Dotel.service.name=$(hostname)-petclinic.service \
+-Dotel.service.name=$(hostname)-petclinic-service \
 -Dsplunk.profiler.enabled=true \
 -Dsplunk.metrics.enabled=true \
 -Dotel.resource.attributes=deployment.environment=$(hostname)-petclinic,version=0.314 \
 -jar target/spring-petclinic-*.jar --spring.profiles.active=mysql
 ```
 
-Go back to the application and generate some more traffic. Then, back in the Splunk APM UI we can drill down on a recent trace and see the new `version` attribute in a span.
+Back in the Splunk APM UI we can drill down on a recent trace and see the new `version` attribute in a span.

content/en/other/pet-clinic/logobserver.md

@@ -95,7 +95,7 @@ And then run the application again:
 
 ```bash
 java \
--Dotel.service.name=$(hostname)-petclinic.service \
+-Dotel.service.name=$(hostname)-petclinic-service \
 -Dsplunk.profiler.enabled=true \
 -Dsplunk.metrics.enabled=true \
 -Dotel.resource.attributes=deployment.environment=$(hostname)-petclinic,version=0.314 \

content/en/other/pet-clinic/rum.md

@@ -39,25 +39,27 @@ Let's then edit the layout page:
 vi src/main/resources/templates/fragments/layout.html
 ```
 
-and let's insert the snipped we generated above in the `<head>` section of the page. Now we need to rebuild the application and run it again:
+Next, insert the snippet we generated above in the `<head>` section of the page. Now we need to rebuild the application and run it again:
 
 ## 2. Rebuild PetClinic
 
-run the maven command to compile/build/package PetClinic:
+Run the `maven` command to compile/build/package PetClinic:
 
 ```bash
 ./mvnw package -Dmaven.test.skip=true
 ```
 
 ```bash
 java \
--Dotel.service.name=$(hostname)-petclinic.service \
+-Dotel.service.name=$(hostname)-petclinic-service \
 -Dsplunk.profiler.enabled=true \
 -Dsplunk.metrics.enabled=true \
 -Dotel.resource.attributes=deployment.environment=$(hostname)-petclinic,version=0.314 \
 -jar target/spring-petclinic-*.jar --spring.profiles.active=mysql
 ```
 
-Then let's visit the application again to generate more traffic `http://<VM_IP_ADDRESS>:8080`, now we should see RUM traces being reported
+Then let's visit the application using a browser to generate real-user traffic `http://<VM_IP_ADDRESS>:8080`, now we should see RUM traces being reported.
 
 Let's visit RUM and see some of the traces and metrics **Hamburger Menu → RUM** and you will see some of the Spring PetClinic URLs showing up in the UI.
+
+When you drill down into a RUM trace you will see a link to APM in the spans. Clicking on the trace ID will take you to the corresponding APM trace for the current RUM trace.

workshop/petclinic/locustfile.py

@@ -0,0 +1,14 @@
+import time
+from locust import HttpUser, task, between
+
+class QuickstartUser(HttpUser):
+    wait_time = between(1, 5)
+
+    def on_start(self):
+        self.client.get("/")
+
+    @task(3)
+    def view_items(self):
+        for item_id in range(1, 10):
+            self.client.get(f"/owners/{item_id}", name="/owners")
+            time.sleep(1)