Skip to content

Commit 92847bd

Browse files
committed
Updated screenshots and minor edits
1 parent 8eb290e commit 92847bd

File tree

17 files changed

+22
-911
lines changed

17 files changed

+22
-911
lines changed

content/en/ninja-workshops/1-automatic-discovery/2-petclinic-kubernetes/2-preparation/1-otel.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ weight: 1
77

88
To get Observability signals (**metrics, traces** and **logs**) into **Splunk Observability Cloud** we need to deploy the Splunk OpenTelemetry Collector into the Kubernetes cluster.
99

10-
For this workshop, we will be using the Splunk OpenTelemetry Collector Helm Chart. First, we need to add the Helm chart repository to Helm and run helm repo update to ensure the latest version:
10+
For this workshop, we will be using the Splunk OpenTelemetry Collector Helm Chart. First, we need to add the Helm chart repository to Helm and run `helm repo update` to ensure the latest version:
1111

1212
{{< tabs >}}
1313
{{% tab title="Install Helm Chart" %}}

content/en/ninja-workshops/1-automatic-discovery/2-petclinic-kubernetes/2-preparation/2-petclinic.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ The first deployment of our application will be using prebuilt containers to giv
1010
{{% tab title="kubectl apply" %}}
1111

1212
``` bash
13-
kubectl apply -f ~/workshop/petclinic/petclinic-deploy.yaml
13+
kubectl apply -f ~/workshop/petclinic/deployment.yaml
1414
```
1515

1616
{{% /tab %}}
@@ -42,7 +42,7 @@ configmap/scriptfile created
4242
{{% /tab %}}
4343
{{< /tabs >}}
4444

45-
At this point, we can verify the deployment by checking that the Pods are running. The containers need to be downloaded and started so this may take a couple of minutes.
45+
At this point, we can verify the deployment by checking that the Pods are running. The containers need to be downloaded and started, so this may take a couple of minutes.
4646

4747
{{< tabs >}}
4848
{{% tab title="kubectl get pods" %}}
@@ -82,13 +82,13 @@ curl http://ifconfig.me
8282

8383
```
8484

85-
You can validate if the application is running by visiting **http://<IP_ADDRESS>:81** (replace **<IP_ADDRESS>** with the IP address you obtained above). You should see the PetClinic application running. The application is also running on ports **80** & **443** if you prefer to use those or port **81** is unreachable.
85+
Validate if the application is running by visiting **http://<IP_ADDRESS>:81** (replace **<IP_ADDRESS>** with the IP address you obtained above). You should see the PetClinic application running. The application is also running on ports **80** & **443** if you prefer to use those or port **81** is unreachable.
8686

8787
![Pet shop](../../images/petclinic.png)
8888

8989
Make sure the application is working correctly by visiting the **All Owners** **(1)** and **Veterinarians** **(2)** tabs, confirming that you see a list of names on each page.
9090

91-
![owners](../../images/petclinic-owners.png)
91+
![Owners](../../images/petclinic-owners.png)
9292

9393
<!--
9494
Once they are all running, the application will take a few minutes to fully start up, create the database and synchronize all the services, so let's use the time to check the local private repository is active.

content/en/ninja-workshops/1-automatic-discovery/2-petclinic-kubernetes/2-preparation/_index.md

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ The instructor will provide you with the login information for the instance that
1111
When you first log into your instance, you will be greeted by the Splunk Logo as shown below. If you have any issues connecting to your workshop instance, please reach out to your Instructor.
1212

1313
``` text
14-
$ ssh -p 2222 splunk@<ip-address>
14+
$ ssh -p 2222 splunk@<IP-ADDRESS>
1515
1616
███████╗██████╗ ██╗ ██╗ ██╗███╗ ██╗██╗ ██╗ ██╗
1717
██╔════╝██╔══██╗██║ ██║ ██║████╗ ██║██║ ██╔╝ ╚██╗
@@ -20,9 +20,7 @@ $ ssh -p 2222 splunk@<ip-address>
2020
███████║██║ ███████╗╚██████╔╝██║ ╚████║██║ ██╗ ██╔╝
2121
╚══════╝╚═╝ ╚══════╝ ╚═════╝ ╚═╝ ╚═══╝╚═╝ ╚═╝ ╚═╝
2222
Last login: Mon Feb 5 11:04:54 2024 from [Redacted]
23-
Waiting for cloud-init status...
24-
Your instance is ready!
25-
splunk@show-no-config-i-0d1b29d967cb2e6ff:~$
23+
splunk@show-no-config-i-0d1b29d967cb2e6ff ~ $
2624
```
2725

2826
To ensure your instance is configured correctly, we need to confirm that the required environment variables for this workshop are set correctly. In your terminal, run the following script and check that the environment variables are present and set with actual valid values:

content/en/ninja-workshops/1-automatic-discovery/2-petclinic-kubernetes/3-verify-setup/_index.md

Lines changed: 6 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -9,19 +9,14 @@ Once the installation has completed, you can log in to **Splunk Observability Cl
99

1010
From the left-hand menu, click on **Infrastructure** and select **Kubernetes**, then select the **Kubernetes nodes** pane. Once you are in the **Kubernetes nodes** view, change the **Time** filter from **-4h** to the last 15 minutes **(-15m)** to focus on the latest data.
1111

12-
Next, from the list of clusters, select the cluster name of your workshop instance. Note: You can get the unique part from your cluster name by using the `INSTANCE` from the output from the shell script you ran earlier. **(1)**
12+
Next, from the list of nodes, select the Node name of your workshop instance. Note: You can get the unique part from your cluster name by using the `INSTANCE` from the output from the shell script you ran earlier. **(1)**
1313

14-
![NavigatorI](../images/navigatorlist.png)
14+
![NavigatorList](../images/navigatorlist.png)
1515

16-
You can now select your node by clicking on its name **(1)** in the node list.
16+
Open the **Hierarchy Map** by clicking on the *Hierarchy Map* link in the gray pane to show the graphical representation of your node.
1717

18-
![NavigatorII](../images/nodelist.png)
18+
![HeirarchyMap](../images/hierarchymap.png)
1919

20-
Open the **Hierarchy Map** by clicking on the *Hierarchy Map* **(1)** link in the gray pane to show the graphical representation of your node.
20+
You will now only have your cluster visible. Scroll down the page to see the metrics coming in from your cluster. Locate the **Node log events rate** **(1)** chart and click on a vertical bar to see the log entries coming in from your cluster.
2121

22-
![NavigatorII](../images/hierarchymap.png)
23-
24-
You will now only have your cluster visible.
25-
Scroll down the page to see the metrics coming in from your cluster. Locate the **Node log events rate** chart and click on a vertical bar to see the log entries coming in from your cluster.
26-
27-
![logs](../images/k8s-peek-at-logs.png)
22+
![Logs](../images/k8s-peek-at-logs.png)

content/en/ninja-workshops/1-automatic-discovery/2-petclinic-kubernetes/4-apm/1-patching-deployment.md

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ Image: quay.io/phagen/spring-petclinic-api-gateway:0.0.2
2323
{{% /tab %}}
2424
{{< /tabs >}}
2525

26-
Next, enable the Java automatic discovery and configuration for all of the services by adding the annotation to the deployments. The following command will patch the all deployments. This will trigger the OpenTelemetry Operator to inject the `splunk-otel-java` image into the Pods:
26+
Next, enable the Java automatic discovery and configuration for all the services by adding the annotation to the deployments. The following command will patch the all deployments. This will trigger the OpenTelemetry Operator to inject the `splunk-otel-java` image into the Pods:
2727

2828
{{< tabs >}}
2929
{{% tab title="Patch all PetClinic services" %}}
@@ -77,5 +77,3 @@ Navigate back to the Kubernetes Navigator in **Splunk Observability Cloud**. Aft
7777
![restart](../../images/k8s-navigator-restarted-pods.png)
7878

7979
Wait for the Pods to turn green in the Kubernetes Navigator, then go tho the next section.
80-
81-

content/en/ninja-workshops/1-automatic-discovery/2-petclinic-kubernetes/4-apm/2-apm-data.md

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,8 @@ linkTitle: 2. Viewing APM Data
44
weight: 2
55
---
66

7-
Return to Splunk Observability Cloud, and from the left-hand menu click on ![APM](../../images/apm-icon.png?classes=inline&height=25px) **APM** to see the data generated by the traces from the newly instrumented services. Change the **Environment** filter **(1)** to the name of your workshop instance in the dropdown box. (Note: this will be **`<INSTANCE>-workshop`** where **`INSTANCE`** is the value from the shell script you ran earlier. Ensure it is the only one selected.)
7+
In the left-hand menu click on **APM** to see the data generated by the traces from the newly instrumented services. Change the **Environment** filter **(1)** to the name of your workshop instance in the dropdown box. (Note: this will be **`<INSTANCE>-workshop`** where **`INSTANCE`** is the value from the shell script you ran earlier. Ensure it is the only one selected.)
88

99
![apm](../../images/zero-config-first-services-overview.png)
1010

11-
You will see the name **(2)** of the **api-gateway** service and metrics in the Latency and Request & Errors charts. (If you see a Critical Alert, you can ignore it as it is caused by the sudden request increase generated by the load generator). You will also see the rest of the services appear.
12-
13-
Once you see the Customer service, Vets service and Visits services as shown in the screenshot above, click on the **Service Map** **(3)** pane to get ready for the next section.
11+
If you see a Critical Alert, you can ignore it as it is caused by the sudden request increase generated by the load generator **(2)**. Click on the **Service Map** **(3)** pane to get ready for the next section.

content/en/ninja-workshops/1-automatic-discovery/2-petclinic-kubernetes/5-traces/1-service-map.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,14 +6,14 @@ weight: 1
66

77
![apm map](../../images/zero-config-first-services-map.png)
88

9-
The above map shows all the interactions between all of the services. The map may still be in an interim state as it will take the Petclinic Microservice application a few minutes to start up and fully synchronize. Reducing the time filter to a custom time of **2 minutes** by entering -2m will help. You can click on the **Refresh** button **(1)** in the top right-hand corner of the screen. The initial startup-related errors indicated by red circles will eventually disappear.
9+
The above map shows all the interactions between all the services. The map may still be in an interim state as it will take the PetClinic Microservice application a few minutes to start up and fully synchronize. Reducing the time filter to a custom time of **2 minutes** by entering **-2m** will help. You can click on the **Refresh** button **(1)** in the top right-hand corner of the screen. The initial startup-related errors indicated by red circles will eventually disappear.
1010

1111
Next, let's examine the metrics that are available for each service that is instrumented by visiting the request, error, and duration (RED) metrics Dashboard.
1212

1313
For this exercise, we are going to use a common scenario you would use if your service operation was showing high latency or errors.
1414

15-
Click on **customers-service** in the Dependency map **(1)**, then make sure the `customers-service` is selected in the **Services** dropdown box **(2)**. Next, select `GET /Owners` from the Operations dropdown **(3**)** adjacent to the Service name.
15+
Click on **customers-service** in the Dependency map, then make sure the `customers-service` is selected in the **Services** dropdown box **(1)**. Next, select `GET /owners` from the Operations dropdown **(2)** adjacent to the Service name.
1616

17-
This should give you the workflow with a filter on `GET /owners` **(1)** as shown below.
17+
This should give you the workflow with a filter on `GET /owners` as shown below:
1818

1919
![select a trace](../../images/select-workflow.png)

content/en/ninja-workshops/1-automatic-discovery/2-petclinic-kubernetes/5-traces/4-red-metrics.md

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,12 +4,10 @@ linkTitle: 4. Service Centric View
44
weight: 4
55
---
66

7-
Splunk APM provide **Service Centric Views** that provide engineers a deep understanding of service performance in one centralized view. Now, across every service, engineers can quickly identify errors or bottlenecks from a service’s underlying infrastructure, pinpoint performance degradations from new deployments, and visualize the health of every third party dependency.
7+
Splunk APM provide **Service Centric Views** that provide engineers a deep understanding of service performance in one centralized view. Now, across every service, engineers can quickly identify errors or bottlenecks from a service’s underlying infrastructure, pinpoint performance degradation from new deployments, and visualize the health of every third party dependency.
88

9-
To see this dashboard for the `api-gateway`, click on **APM** from the right hand menu and go to the **Dependency Map**. Make sure you have the `api-gateway` service selected in the Service Map, then click on the ***View Service** button in the top, right-hand pane. This will bring you to the Service Centric View dashboard:
9+
To see this dashboard for the `api-gateway`, click on **APM** from the left-hand menu and then click on the `api-gateway` service in the list. This will bring you to the Service Centric View dashboard:
1010

1111
![service_maps](../../images/service-view.png)
1212

13-
This view, which is available for each of your instrumented services, offers an overview of **Service metrics**, **Runtime metrics** and **Infrastructure metrics**.
14-
15-
You can select the **Back** function of you browser to go back to the previous view.
13+
This view, which is available for each of your instrumented services, offers an overview of **Service metrics**, **Error breakdown**, **Runtime metrics (Java)** and **Infrastructure metrics**.
Binary file not shown.
144 KB
Loading

0 commit comments

Comments
 (0)