You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
If you are attempting this workshop on an AWS/EC2 instance you will have to patch the collector to expose the hostname of the instance:
66
+
Next, we will patch the collector to expose the hostname of the instance and not the AWS instance ID. This will make it easier to filter data in the UI. Run the following command to patch the collector:
@@ -76,7 +75,6 @@ Once the `agent_config.yaml` has been patched, you will need to restart the coll
76
75
sudo systemctl restart splunk-otel-collector
77
76
```
78
77
79
-
{{% /notice %}}
80
78
Once the installation is completed, you can navigate to the **Hosts with agent installed** dashboard to see the data from your host, **Dashboards → Hosts with agent installed**.
81
79
82
80
Use the dashboard filter and select `host.name` and type or select the hostname of your workshop instance (you can get this from the command prompt in your terminal session). Once you see data flowing for your host, we are then ready to get started with the APM component.
Copy file name to clipboardExpand all lines: content/en/other/pet-clinic/2-zero-configuration.md
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -39,7 +39,7 @@ Next, run the `maven` command to compile/build/package PetClinic:
39
39
```
40
40
41
41
{{% notice style="info" %}}
42
-
This will take a few minutes the first time you run, `maven` will download a lot of dependencies before it compiles the application. Future executions will be a lot quicker.
42
+
This will take a few minutes the first time you run, `maven` will download a lot of dependencies before it compiles the application. Future builds will be a lot quicker.
43
43
{{% /notice %}}
44
44
45
45
Once the build completes, you need to obtain the public IP address of the instance you are running on. You can do this by running the following command:
@@ -104,7 +104,7 @@ OpenJDK 64-Bit Server VM warning: Sharing is only supported for boot loader clas
104
104
105
105
## 3. Review Profiling Data Collection
106
106
107
-
You can now visit the Splunk APM UI and examine the application components, traces, profiling, DB Query performance and metrics. From the left-hand menu **APM** → **Explore**, click the environment dropdown and select your environment e.g. `<INSTANCE>-petclinic-service` (where`<INSTANCE>` is replaced with the value you noted down earlier).
107
+
You can now visit the Splunk APM UI and examine the application components, traces, profiling, DB Query performance and metrics. From the left-hand menu **APM** → **Explore**, click the environment dropdown and select your environment e.g. `<INSTANCE>-petclinic` (where`<INSTANCE>` is replaced with the value you noted down earlier).
Then let's visit the application using a browser to generate real-user traffic `http://<IP_ADDRESS>:8083`, now we should see RUM traces being reported.
78
+
Then let's visit the application using a browser to generate real-user traffic `http://<IP_ADDRESS>:8083`.
80
79
81
-
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.
80
+
In RUM, filter down into the environment as defined in the RUM snippet above and click through to the dashboard.
82
81
83
82
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.
Copy file name to clipboardExpand all lines: content/en/other/pet-clinic/4-log-observer-connect.md
+8-6Lines changed: 8 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -5,13 +5,13 @@ weight: 4
5
5
6
6
## 1. Introduction
7
7
8
-
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.
8
+
For the Splunk Log Observer component, we will configure the Spring PetClinic application to write logs to a file and configure the Splunk OpenTelemetry Collector to read (tail) that log file and send the logs to Splunk Cloud.
9
9
10
10
## 2. OpenTelemetry Filelog Configuration
11
11
12
-
We need to configure the Splunk OpenTelemetry Collector to tail the Spring PetClinic log file and report the data to the Splunk Cloud HEC URL.
12
+
We need to configure the Splunk OpenTelemetry Collector to tail the Spring PetClinic log file and send the log data to Splunk Cloud.
13
13
14
-
The Splunk OpenTelemetry Collector uses the [**Filelog Receiver**](https://github.com/open-telemetry/opentelemetry-collector-contrib/blob/main/receiver/filelogreceiver/README.md) to consume logs. We will need to edit the collectors' configuration file:
14
+
The Splunk OpenTelemetry Collector uses **Fluentd** by default but we will change the configuration to use the OpenTelemetry [**Filelog Receiver**](https://github.com/open-telemetry/opentelemetry-collector-contrib/blob/main/receiver/filelogreceiver/README.md) to consume the logs. We will need to edit the collectors' configuration file:
15
15
16
16
```bash
17
17
sudo vi /etc/otel/collector/agent_config.yaml
@@ -99,12 +99,14 @@ java \
99
99
100
100
## 4. View Logs
101
101
102
-
From the left-hand menu click on **Log Observer** and ensure **Index** set to **splunk4rookies-workshop**.
102
+
From the left-hand menu click on **Log Observer** and ensure **Index** is set to **splunk4rookies-workshop**.
103
103
104
-
Next, click **Add Filter** search for the field `service_name` select the value `<your host name>-petclinic-service` and click `=` (include). You should now see only the log messages from your PetClinic application.
104
+
Next, click **Add Filter** search for the field `service_name` select the value `<INSTANCE>-petclinic-service` and click `=` (include). You should now see only the log messages from your PetClinic application.
105
105
106
106
107
107
108
108
## 4. Summary
109
109
110
-
This is the end of the exercise and we have certainly covered a lot of ground. At this point, you should have metrics, traces (APM & RUM), logs, database query performance and code profiling being reported into Splunk Observability Cloud. **Congratulations**!
110
+
This is the end of the workshop and we have certainly covered a lot of ground. At this point, you should have metrics, traces (APM & RUM), logs, database query performance and code profiling being reported into Splunk Observability Cloud.
Copy file name to clipboardExpand all lines: content/en/other/pet-clinic/_index.md
+9-11Lines changed: 9 additions & 11 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,32 +4,30 @@ weight: 1
4
4
description: A workshop using Zero Configuration Auto-Instrumentation for Java.
5
5
---
6
6
7
-
The goal is to walk through the basic steps to configure the following components of the Splunk Observability platform:
7
+
The goal is to walk through the basic steps to configure the following components of the **Splunk Observability Cloud** platform:
8
8
9
9
* Splunk Infrastructure Monitoring (IM)
10
10
* Splunk Zero Configuration Auto Instrumentation for Java (APM)
11
11
* Database Query Performance
12
12
* AlwaysOn Profiling
13
13
* Splunk Real User Monitoring (RUM)
14
14
* RUM to APM Correlation
15
-
* Splunk Log Observer
15
+
* Splunk Log Observer (LO)
16
16
17
17
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.
18
18
19
-
Once the application is up and running, we will instantly start seeing metrics and traces via the Zero Configuration Auto Instrumentation for Java that will be used by the Splunk APM product.
19
+
Once the application is up and running, we will instantly start seeing metrics and traces via the **Zero Configuration Auto Instrumentation** for Java that will be used by the **Splunk APM** product.
20
20
21
-
After that, we will instrument PetClinic's end user interface (HTML pages rendered by the application) with the Splunk OpenTelemetry Javascript Libraries (RUM) that will generate RUM traces around all the individual clicks and page loads executed by an end user.
21
+
After that, we will instrument PetClinic's end user interface (HTML pages rendered by the application) with the **Splunk OpenTelemetry Javascript Libraries (RUM)** that will generate RUM traces around all the individual clicks and page loads executed by an end user.
22
22
23
-
Lastly, we will configure the Spring PetClinic application to write application logs to the filesystem and also configure the Splunk OpenTelemetry Collector to read (tail) the logs and send them to Splunk Cloud.
23
+
Lastly, we will configure the Spring PetClinic application to write application logs to the filesystem and also configure the Splunk OpenTelemetry Collector to read (tail) the logs and send them to **Splunk Cloud**.
24
24
25
-
{{% notice title="Prerequisites" style="info" %}}
26
-
A Splunk-run workshop where a host/instance is provided **OR** a self-led workshop on your own host / [multipass instance](https://github.com/splunk/observability-workshop/tree/main/multipass)
0 commit comments