Skip to content

Commit 24cd7de

Browse files
committed
Refactor of Pet-Clinic workshop
1 parent 003c8ba commit 24cd7de

File tree

4 files changed

+14
-10
lines changed

4 files changed

+14
-10
lines changed

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ title: Zero Configuration Java application
33
weight: 3
44
---
55

6-
## Spring PetClinic Application
6+
## 1. Spring PetClinic Application
77

88
First thing we need to setup APM is... well, an application. For this exercise, we will use the Spring Pet Clinic application. This is a very popular sample java application built with Spring framework (Springboot).
99

@@ -67,7 +67,7 @@ Let's go visit our application again to generate some traffic `http://<VM_IP_ADD
6767

6868
**Once your validation is complete you can stop the application by pressing** `Ctrl-c` **.**
6969

70-
## Adding Resource Attributes to Spans
70+
## 2. Adding Resource Attributes to Spans
7171

7272
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`.
7373

content/en/pet-clinic/docs/imt.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
---
2-
title: Install the OpenTelemetry Collector
2+
title: Install the OTel Collector
33
weight: 2
44
---
55

6-
## Install The Open Telemetry Collector
6+
## 1. Introduction
77

88
The OpenTelemetry Collector is the core component of instrumenting infrastructure and applications. Its role is to collect and send:
99

@@ -14,6 +14,8 @@ The OpenTelemetry Collector is the core component of instrumenting infrastructur
1414

1515
Splunk Observability Cloud offers wizards to walk you through the setup of the Collector on both your infrastructure and applications. By default, the wizard will only provide the commands to only install the collector.
1616

17+
## 2. Configure environment variables
18+
1719
If you have already completed the **Splunk IM** workshop you can take advantage of the existing environment variables. Otherwise, create the `ACCESS_TOKEN` and `REALM` environment variables to use in the proceeding OpenTelemetry Collector install command. For instance, if your realm is `us1`, you would type `export REALM=us1` and for `eu0` type `export REALM=eu0` etc.
1820

1921
{{< tabpane >}}
@@ -32,6 +34,8 @@ export REALM="<replace_with_REALM>"
3234
If you have completed the Splunk IM workshop, please ensure you have deleted the collector running in Kubernetes before continuing. This can be done by running the following command: `helm delete splunk-otel-collector`.
3335
{{% /alert %}}
3436

37+
## 3. Install the OpenTelemetry Collector
38+
3539
We can then go ahead and install the Collector. There are two additional parameters passed to the install script, they are `--with-instrumentation` and `--deployment-environment`. The `--with-instrumentation` option the installer will install the agent from the Splunk distribution of OpenTelemetry Java, which is then loaded automatically when the Pet Clinic Java application starts up. No configuration required!
3640

3741
``` text

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

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,11 +3,11 @@ title: Log Observer
33
weight: 5
44
---
55

6-
## Splunk Log Observer
6+
## 1. Introduction
77

88
For the Splunk Log Observer component, we will configure the Spring PetClinic application to write logs to a file in the filesystem and configure the Splunk OpenTelemetry Collect to read (tail) that log file and report the information to the Splunk Observability Platform.
99

10-
### FluentD Configuration
10+
## 2. FluentD Configuration
1111

1212
We need to configure the Splunk OpenTelemetry Collector to tail the Spring Pet Clinic log file and report the data to the Splunk Observability Cloud endpoint.
1313

@@ -48,7 +48,7 @@ And paste the contents from the snippet above. Once the file is created, we need
4848
sudo systemctl restart td-agent
4949
```
5050

51-
### PetClinic Logback Settings
51+
## 3. Logback Settings
5252

5353
The Spring PetClinic application can be configure to use a number of different java logging libraries. In this scenario, we are using logback. Here's a sample logback configuration file:
5454

@@ -109,6 +109,6 @@ And you can add a filter to select only log messages from your host and the Spri
109109
1. Add Filter → Fields → `host.name``<your host name>`
110110
2. Add Filter → Fields → `service.name``<your host name>-petclinic.service`
111111

112-
### Summary
112+
## 4. Summary
113113

114114
This the end of the exercise and we have certainly covered a lot of ground. At this point you should have metrics, traces, logs, database query performance and code profiling being reported into Splunk Observability Cloud. **Congratulations**!

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ title: Real User Monitoring
33
weight: 4
44
---
55

6-
## Splunk Real User Monitoring
6+
## 1. Enable RUM
77

88
For the Real User Monitoring (RUM) instrumentation, we will add the Open Telemetry Javascript [https://github.com/signalfx/splunk-otel-js-web](https://github.com/signalfx/splunk-otel-js-web) snippet in the pages, we will use the wizard again **Data Management → Add Integration → RUM Instrumentation → Browser Instrumentation**.
99

@@ -41,7 +41,7 @@ vi src/main/resources/templates/fragments/layout.html
4141

4242
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:
4343

44-
## Rebuild PetClinic
44+
## 2. Rebuild PetClinic
4545

4646
run the maven command to compile/build/package PetClinic:
4747

0 commit comments

Comments
 (0)