Skip to content

Commit f3dbce7

Browse files
committed
Fixes to support Splunk Show instances
1 parent 86695fd commit f3dbce7

File tree

11 files changed

+53
-35
lines changed

11 files changed

+53
-35
lines changed

content/en/apm/online-boutique/validate-apm.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -9,15 +9,15 @@ weight: 2
99

1010
Go to **Dashboards → All Dashboards → APM Services → Service**. Here we can view the RED metrics (Rate, Error & Duration) for the Online Boutique application.
1111

12-
For this we need to know the name of your application environment. In this workshop all the environments use: `<hostname>-workshop`.
12+
For this, we need to know the name of your application environment. In this workshop all the environments use: `<instance>-workshop`.
1313

14-
To find the hostname, on the AWS/EC2 instance run the following command:
14+
To find the `instance`, on the AWS/EC2 instance run the following command:
1515

1616
{{< tabs >}}
17-
{{% tab title="Echo Hostname" %}}
17+
{{% tab title="Echo Instance" %}}
1818

1919
``` bash
20-
echo $(hostname)-workshop
20+
echo $INSTANCE-workshop
2121
```
2222

2323
{{% /tab %}}
@@ -30,23 +30,23 @@ bdzx-workshop
3030
{{% /tab %}}
3131
{{< /tabs >}}
3232

33-
Select your environment you found in the previous step then select the `frontend` service and set time to Past 15 minutes.
33+
Select the environment you found in the previous step then select the `frontend` service and set the time to Past 15 minutes.
3434

3535
![APM Dashboard](../../images/online-boutique-service-dashboard.png)
3636

37-
With this automatically generated dashboard you can keep an eye out for the health of your service(s) using RED (Rate, Error & Duration) metrics. It provides various performance related charts as well as correlated information on the underlying host and Kubernetes pods (if applicable).
37+
With this automatically generated dashboard, you can keep an eye out for the health of your service(s) using RED (Rate, Error & Duration) metrics. It provides various performance-related charts as well as correlated information on the underlying host and Kubernetes pods (if applicable).
3838

3939
Take some time to explore the various charts in this dashboard
4040

4141
---
4242

4343
## 2. APM Metrics
4444

45-
In the left hand menu card click on **APM** this will bring you to the APM Overview dashboard:
45+
In the left-hand menu card click on **APM** this will bring you to the APM Overview dashboard:
4646

4747
![select APM](../../images/online-boutique-apm.png)
4848

49-
Select the **Explore** on the right hand side and select your environment you found before and set the time to 15 minutes. This will show you the automatically generated Dependency/Service Map for the Online Boutique application.
49+
Select **Explore** on the right-hand side select the environment you found before and set the time to 15 minutes. This will show you the automatically generated Dependency/Service Map for the Online Boutique application.
5050

5151
It should look similar to the screenshot below:
5252

@@ -59,7 +59,7 @@ The legend at the bottom of the page explains the different visualizations in th
5959
* Service requests, error rate and root error rate.
6060
* Request rate, latency and error rate
6161

62-
Also in this view you can see the overall Error and Latency rates over time charts.
62+
Also in this view, you can see the overall Error and Latency rates over time charts.
6363

6464
## 3. OpenTelemetry Dashboard
6565

content/en/imt/gdi/_index.md

Lines changed: 23 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -84,16 +84,34 @@ Install the OpenTelemetry Collector Helm chart with the following commands, do *
8484
helm install splunk-otel-collector \
8585
--set="splunkObservability.realm=$REALM" \
8686
--set="splunkObservability.accessToken=$ACCESS_TOKEN" \
87-
--set="clusterName=$(hostname)-k3s-cluster" \
87+
--set="clusterName=$INSTANCE-k3s-cluster" \
88+
--set="splunkObservability.logsEnabled=false" \
89+
--set="logsEngine=otel" \
90+
--set="splunkObservability.profilingEnabled=true" \
91+
--set="splunkObservability.infrastructureMonitoringEventsEnabled=true" \
92+
--set="environment=$INSTANCE-workshop" \
93+
--set="splunkPlatform.endpoint=$HEC_URL" \
94+
--set="splunkPlatform.token=$HEC_TOKEN" \
95+
--set="splunkPlatform.index=splunk4rookies-workshop" \
96+
splunk-otel-collector-chart/splunk-otel-collector \
97+
-f ~/workshop/k3s/otel-collector.yaml
98+
99+
```
100+
<!--
101+
```bash
102+
helm install splunk-otel-collector \
103+
--set="splunkObservability.realm=$REALM" \
104+
--set="splunkObservability.accessToken=$ACCESS_TOKEN" \
105+
--set="clusterName=$INSTANCE-k3s-cluster" \
88106
--set="splunkObservability.logsEnabled=true" \
89107
--set="logsEngine=otel" \
90108
--set="splunkObservability.profilingEnabled=true" \
91109
--set="splunkObservability.infrastructureMonitoringEventsEnabled=true" \
92-
--set="environment=$(hostname)-workshop" \
110+
--set="environment=$INSTANCE-workshop" \
93111
splunk-otel-collector-chart/splunk-otel-collector \
94112
-f ~/workshop/k3s/otel-collector.yaml
95113
```
96-
114+
-->
97115
{{% /tab %}}
98116
{{% tab title="Helm Install Output" %}}
99117

@@ -179,12 +197,12 @@ In the Splunk UI, click the **>>** bottom left and click on **Infrastructure**.
179197

180198
Under **Containers** click on **Kubernetes** to open the Kubernetes Navigator Cluster Map to ensure metrics are being sent in.
181199

182-
Validate that your cluster is discovered and reporting by finding your cluster (in the workshop you will see many other clusters). To find your cluster name run the following command and copy the output to your clipboard:
200+
Validate that your cluster is discovered and reported by finding your cluster (in the workshop you will see many other clusters). To find your cluster name run the following command and copy the output to your clipboard:
183201

184202
{{% tab title="Echo Cluster Name" %}}
185203

186204
```bash
187-
echo $(hostname)-k3s-cluster
205+
echo $INSTANCE-k3s-cluster
188206
```
189207

190208
{{% /tab %}}

content/en/imt/gdi/nginx.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -139,7 +139,7 @@ This will start a gentle continuous load on the application.
139139

140140
As you can see from the above screenshot, most of the calls will report a fail, this is expected, as we have not yet deployed the application behind it, however, NGINX is reporting on your attempts and you should be able to see those metrics.
141141

142-
Validate you are seeing those metrics in the UI by selecting **Dashboards → Built-in Dashboard Groups → NGINX → NGINX Servers**. Using the **Overrides** filter on `k8s.cluster.name:`, find the name of your cluster as returned by `echo $(hostname)-k3s-cluster` in the terminal.
142+
Validate you are seeing those metrics in the UI by selecting **Dashboards → Built-in Dashboard Groups → NGINX → NGINX Servers**. Using the **Overrides** filter on `k8s.cluster.name:`, find the name of your cluster as returned by `echo $INSTANCE-k3s-cluster` in the terminal.
143143

144144
![NGINX Dashboard](../../images/nginx-dashboard.png)
145145

content/en/imt/monitoring-as-code/_index.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -124,7 +124,7 @@ The plan command alone will not actually carry out the proposed changes, and so
124124
{{% tab title="Execution Plan" %}}
125125

126126
```bash
127-
terraform plan -var="api_token=$API_TOKEN" -var="realm=$REALM" -var="o11y_prefix=[$(hostname)]"
127+
terraform plan -var="api_token=$API_TOKEN" -var="realm=$REALM" -var="o11y_prefix=[$INSTANCE]"
128128
```
129129

130130
{{% /tab %}}
@@ -153,7 +153,7 @@ Due to this being a workshop it is required that the prefix is to be unique so y
153153
{{% tab title="Apply Plan" %}}
154154

155155
``` bash
156-
terraform apply -var="api_token=$API_TOKEN" -var="realm=$REALM" -var="o11y_prefix=[$(hostname)]"
156+
terraform apply -var="api_token=$API_TOKEN" -var="realm=$REALM" -var="o11y_prefix=[$INSTANCE]"
157157
```
158158

159159
{{% /tab %}}
@@ -166,10 +166,10 @@ Apply complete! Resources: 146 added, 0 changed, 0 destroyed.
166166
{{% /tab %}}
167167
{{< /tabs >}}
168168

169-
Once the apply has completed, validate that the detectors were created, under the **Alerts & Detectors** and click on the **Detectors** tab. They will be prefixed by the hostname of your instance. To check the prefix value run:
169+
Once the apply has been completed, validate that the detectors were created, under the **Alerts & Detectors** and click on the **Detectors** tab. They will be prefixed by the instance name. To check the prefix value run:
170170

171171
``` bash
172-
echo $(hostname)
172+
echo $INSTANCE
173173
```
174174

175175
You will see a list of the new detectors and you can search for the prefix that was output from above.

content/en/other/hpa/1-deploy-otel.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -69,7 +69,7 @@ Install the OpenTelemetry Collector Helm chart into a new **splunk** namespace w
6969
helm install splunk-otel-collector \
7070
--set="splunkObservability.realm=$REALM" \
7171
--set="splunkObservability.accessToken=$ACCESS_TOKEN" \
72-
--set="clusterName=$(hostname)-k3s-cluster" \
72+
--set="clusterName=$INSTANCE-k3s-cluster" \
7373
--set="splunkObservability.logsEnabled=true" \
7474
--set="splunkObservability.infrastructureMonitoringEventsEnabled=true" \
7575
splunk-otel-collector-chart/splunk-otel-collector \

content/en/other/hpa/3-deploy-apache.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,7 @@ To use the Apache configuration, you can upgrade the existing Splunk OpenTelemet
7272
helm upgrade splunk-otel-collector \
7373
--set="splunkObservability.realm=$REALM" \
7474
--set="splunkObservability.accessToken=$ACCESS_TOKEN" \
75-
--set="clusterName=$(hostname)-k3s-cluster" \
75+
--set="clusterName=$INSTANCE-k3s-cluster" \
7676
--set="splunkObservability.logsEnabled=true" \
7777
--set="splunkObservability.infrastructureMonitoringEventsEnabled=true" \
7878
splunk-otel-collector-chart/splunk-otel-collector \

content/en/other/lambda-kinesis/1-setup.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -45,15 +45,15 @@ git clone https://github.com/kdroukman/o11y-lambda-lab.git
4545

4646
In your Splunk Observability Cloud Organisation (Org) obtain your Access Token and Realm Values.
4747

48-
Please reset your environment variables from the earlier lab. Take care that for this lab we may be using different names - make sure to match the Environment Variable names bellow.
48+
Please reset your environment variables from the earlier lab. Take care that for this lab we may be using different names - make sure to match the Environment Variable names below.
4949

5050
{{< tabs >}}
5151
{{% tab title="Export Environment Variables" %}}
5252

5353
``` ini
5454
export ACCESS_TOKEN=CHANGE_ME \
5555
export REALM=CHANGE_ME \
56-
export PREFIX=$(hostname)
56+
export PREFIX=$INSTANCE
5757
```
5858

5959
{{% /tab %}}

content/en/other/lambda-kinesis/3-lambdas-in-splunk.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ Now it's time to check how your Lambda traffic has been captured in Splunk APM.
1010

1111
## Navigate to your Splunk Observability Cloud
1212

13-
Select APM from the Main Menu and then select your APM Environment. Your APM environment should be in the format `$(hostname)-apm-lambda` where the hostname value is a four letter name of your lab host. (Check it by looking at your command prompt, or by running `echo $(hostname)`).
13+
Select APM from the Main Menu and then select your APM Environment. Your APM environment should be in the format `$INSTANCE-apm-lambda` where the hostname value is a four letter name of your lab host. (Check it by looking at your command prompt, or by running `echo $INSTANCE`).
1414

1515
{{% notice style="note" %}} It may take a few minutes for you traces to appear in Splunk APM. Try hitting refresh on your browser until you find your environement name in the list of Envrionments {{% /notice %}}
1616

content/en/other/pet-clinic/2-zero-configuration.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ Once the compilation is complete, you can run the application with the following
4747
```bash
4848
java \
4949
-Dserver.port=8083 \
50-
-Dotel.service.name=$(hostname)-petclinic-service \
50+
-Dotel.service.name=$INSTANCE-petclinic-service \
5151
-jar target/spring-petclinic-*.jar --spring.profiles.active=mysql
5252
```
5353

@@ -103,7 +103,7 @@ Let's launch the PetClinic again using a new resource attribute. Note, that addi
103103
```bash
104104
java \
105105
-Dserver.port=8083 \
106-
-Dotel.service.name=$(hostname)-petclinic-service \
106+
-Dotel.service.name=$INSTANCE-petclinic-service \
107107
-Dotel.resource.attributes=version=0.314 \
108108
-jar target/spring-petclinic-*.jar --spring.profiles.active=mysql
109109
```

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

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -9,24 +9,24 @@ For the Real User Monitoring (RUM) instrumentation, we will add the Open Telemet
99

1010
Select the preconfigured **RUM ACCESS TOKEN** from the dropdown, and click **Next**. Enter **App name** and **Environment** using the following syntax:
1111

12-
- `[hostname]-petclinic-service` - replacing `[hostname]` with your actual hostname.
13-
- `[hostname]-petclinic-env` - replacing `[hostname]` with your actual hostname.
12+
- `[instance]-petclinic-service` - replacing `[instance]` with your actual hostname.
13+
- `[instance]-petclinic-env` - replacing `[instance]` with your actual hostname.
1414

1515
Then you'll need to select the workshop RUM token and define the application and environment names. The wizard will then show a snippet of HTML code that needs to be placed at the top of the pages in the `<head>` section. In this example, we are using:
1616

17-
- Application Name: `<hostname>-petclinic-service`
18-
- Environment: `<hostname>-petclinic-env`
17+
- Application Name: `<instance>-petclinic-service`
18+
- Environment: `<instance>-petclinic-env`
1919

20-
Copy the generated code snippet in the wizard or copy and edit the snippet below accordingly. You need to replace `<REALM>`, `<RUM_ACCESS_TOKEN>` and `<hostname>` with the actual values.
20+
Copy the generated code snippet in the wizard or copy and edit the snippet below accordingly. You need to replace `<REALM>`, `<RUM_ACCESS_TOKEN>` and `<instance>` with the actual values.
2121

2222
``` html
2323
<script src="https://cdn.signalfx.com/o11y-gdi-rum/latest/splunk-otel-web.js" crossorigin="anonymous"></script>
2424
<script>
2525
SplunkRum.init({
2626
beaconUrl: "https://rum-ingest.<REALM>.signalfx.com/v1/rum",
2727
rumAuth: "<RUM_ACCESS_TOKEN>",
28-
app: "<hostname>-petclinic-service",
29-
environment: "<hostname>-petclinic-env"
28+
app: "<instance>-petclinic-service",
29+
environment: "<instance>-petclinic-env"
3030
});
3131
</script>
3232
```
@@ -52,7 +52,7 @@ Run the `maven` command to compile/build/package PetClinic:
5252
```bash
5353
java \
5454
-Dserver.port=8083 \
55-
-Dotel.service.name=$(hostname)-petclinic-service \
55+
-Dotel.service.name=$INSTANCE-petclinic-service \
5656
-Dotel.resource.attributes=version=0.314 \
5757
-jar target/spring-petclinic-*.jar --spring.profiles.active=mysql
5858
```

0 commit comments

Comments
 (0)