Skip to content

Commit 24b64c1

Browse files
2 parents 3f78994 + 725a9fc commit 24b64c1

File tree

163 files changed

+8427
-169
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

163 files changed

+8427
-169
lines changed

.bumpversion.cfg

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
[bumpversion]
2-
current_version = 5.74
2+
current_version = 5.76
33
commit = True
44
Tag = True
55
parse = v?(?P<major>\d+)\.(?P<minor>\d+)

.gitignore

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -63,3 +63,7 @@ workshop/ninja/advanced otel/gateway/otelcol_darwin_arm64_splunk
6363
workshop/ninja/advanced otel/gateway/otelcol-contrib
6464
workshop/tagging/creditcheckservice-java/target/*
6565
workshop/tagging/creditcheckservice-java-with-tags/target/*
66+
*.out
67+
checkpoint-folder
68+
checkpoint-folder/*
69+
workshop/ninja/advanced-otel/3-other-logs/important_logs.log

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99
## Splunk Copyright Notice
1010

1111
``` text
12-
Copyright 2023 Splunk Inc.
12+
Copyright 2025 Splunk Inc.
1313
1414
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
1515
@@ -23,5 +23,5 @@ Unless required by applicable law or agreed to in writing, software distributed
2323
To get started, please proceed to [The Splunk Observability Cloud Workshops Homepage](https://splunk.github.io/observability-workshop/latest/).
2424

2525
Latest versions of the workshop are:
26-
- [v5.74](https://splunk.github.io/observability-workshop/v5.74/)
27-
- [v5.73](https://splunk.github.io/observability-workshop/v5.73/)
26+
- [v5.76](https://splunk.github.io/observability-workshop/v5.76/)
27+
- [v5.75](https://splunk.github.io/observability-workshop/v5.75/)

VERSION

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
5.74
1+
5.76

content/en/ninja-workshops/1-automatic-discovery/1-petclinic-monolith/1-otel-collector.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,13 @@ If you have completed the Splunk IM workshop, please ensure you have deleted the
1818
helm delete splunk-otel-collector
1919
```
2020

21+
The EC2 instance may already have an older version of the collector already installed. To uninstall the collector, run the following commands:
22+
23+
``` bash
24+
curl -sSL https://dl.signalfx.com/splunk-otel-collector.sh > /tmp/splunk-otel-collector.sh
25+
sudo sh /tmp/splunk-otel-collector.sh --uninstall
26+
```
27+
2128
{{% /notice %}}
2229

2330
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 command:
Lines changed: 143 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,143 @@
1+
---
2+
3+
title: Deploy the Splunk OpenTelemetry Collector
4+
linkTitle: 1. Deploy OpenTelemetry Collector
5+
weight: 1.1
6+
draft: false
7+
---
8+
9+
To get Observability signals (**metrics, traces** and **logs**) into **Splunk Observability Cloud** the Splunk OpenTelemetry Collector needs to be deployed into the Kubernetes cluster.
10+
11+
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 update to ensure the latest version:
12+
13+
{{< tabs >}}
14+
{{% tab title="Install Helm Chart" %}}
15+
16+
``` bash
17+
helm repo add splunk-otel-collector-chart https://signalfx.github.io/splunk-otel-collector-chart && helm repo update
18+
```
19+
20+
{{% /tab %}}
21+
{{% tab title="Output" %}}
22+
23+
```text
24+
Using ACCESS_TOKEN={REDACTED}
25+
Using REALM=eu0
26+
"splunk-otel-collector-chart" has been added to your repositories
27+
Using ACCESS_TOKEN={REDACTED}
28+
Using REALM=eu0
29+
Hang tight while we grab the latest from your chart repositories...
30+
...Successfully got an update from the "splunk-otel-collector-chart" chart repository
31+
Update Complete. ⎈Happy Helming!⎈
32+
```
33+
34+
{{% /tab %}}
35+
{{< /tabs >}}
36+
37+
**Splunk Observability Cloud** offers wizards in the UI to walk you through the setup of the OpenTelemetry Collector on Kubernetes, but in the interest of time, we will use the Helm install command below. Additional parameters are set to enable the operator and automatic discovery and configuration.
38+
39+
* `--set="operator.enabled=true"` - this will install the Opentelemetry operator that will be used to handle automatic discovery and configuration.
40+
* `--set="certmanager.enabled=true"` - this will install the required certificate manager for the operator.
41+
* `--set="splunkObservability.profilingEnabled=true"` - this enables Code Profiling via the operator.
42+
43+
To install the collector run the following command, do **NOT** edit this:
44+
45+
{{< tabs >}}
46+
{{% tab title="Helm Install" %}}
47+
48+
```bash
49+
helm install splunk-otel-collector --version {{< otel-version >}} \
50+
--set="operator.enabled=true", \
51+
--set="certmanager.enabled=true", \
52+
--set="splunkObservability.realm=$REALM" \
53+
--set="splunkObservability.accessToken=$ACCESS_TOKEN" \
54+
--set="clusterName=$INSTANCE-k3s-cluster" \
55+
--set="splunkObservability.profilingEnabled=true" \
56+
--set="agent.service.enabled=true" \
57+
--set="environment=$INSTANCE-workshop" \
58+
--set="splunkPlatform.endpoint=$HEC_URL" \
59+
--set="splunkPlatform.token=$HEC_TOKEN" \
60+
--set="splunkPlatform.index=splunk4rookies-workshop" \
61+
splunk-otel-collector-chart/splunk-otel-collector \
62+
-f ~/workshop/k3s/otel-collector.yaml
63+
64+
{{% /tab %}}
65+
{{% tab title="Output" %}}
66+
67+
``` plaintext
68+
LAST DEPLOYED: Fri Apr 19 09:39:54 2024
69+
NAMESPACE: default
70+
STATUS: deployed
71+
REVISION: 1
72+
NOTES:
73+
Splunk OpenTelemetry Collector is installed and configured to send data to Splunk Platform endpoint "https://http-inputs-o11y-workshop-eu0.splunkcloud.com:443/services/collector/event".
74+
75+
Splunk OpenTelemetry Collector is installed and configured to send data to Splunk Observability realm eu0.
76+
77+
[INFO] You've enabled the operator's auto-instrumentation feature (operator.enabled=true)! The operator can automatically instrument Kubernetes hosted applications.
78+
- Status: Instrumentation language maturity varies. See `operator.instrumentation.spec` and documentation for utilized instrumentation details.
79+
- Splunk Support: We offer full support for Splunk distributions and best-effort support for native OpenTelemetry distributions of auto-instrumentation libraries.
80+
```
81+
82+
{{% /tab %}}
83+
{{< /tabs >}}
84+
85+
Ensure the Pods are reported as **Running** before continuing (this typically takes around 30 seconds).
86+
87+
{{< tabs >}}
88+
{{% tab title="kubectl get pods" %}}
89+
90+
``` bash
91+
kubectl get pods | grep splunk-otel
92+
```
93+
94+
{{% /tab %}}
95+
{{% tab title="Output" %}}
96+
97+
``` text
98+
splunk-otel-collector-certmanager-cainjector-5c5dc4ff8f-95z49 1/1 Running 0 10m
99+
splunk-otel-collector-certmanager-6d95596898-vjxss 1/1 Running 0 10m
100+
splunk-otel-collector-certmanager-webhook-69f4ff754c-nghxz 1/1 Running 0 10m
101+
splunk-otel-collector-k8s-cluster-receiver-6bd5567d95-5f8cj 1/1 Running 0 10m
102+
splunk-otel-collector-agent-tspd2 1/1 Running 0 10m
103+
splunk-otel-collector-operator-69d476cb7-j7zwd 2/2 Running 0 10m
104+
```
105+
106+
{{% /tab %}}
107+
{{< /tabs >}}
108+
109+
Ensure there are no errors reported by the Splunk OpenTelemetry Collector (press `ctrl + c` to exit) or use the installed **awesome** `k9s` terminal UI for bonus points!
110+
111+
{{< tabs >}}
112+
{{% tab title="kubectl logs" %}}
113+
114+
``` bash
115+
kubectl logs -l app=splunk-otel-collector -f --container otel-collector
116+
```
117+
118+
{{% /tab %}}
119+
{{% tab title="Output" %}}
120+
121+
```text
122+
2021-03-21T16:11:10.900Z INFO service/service.go:364 Starting receivers...
123+
2021-03-21T16:11:10.900Z INFO builder/receivers_builder.go:70 Receiver is starting... {"component_kind": "receiver", "component_type": "prometheus", "component_name": "prometheus"}
124+
2021-03-21T16:11:11.009Z INFO builder/receivers_builder.go:75 Receiver started. {"component_kind": "receiver", "component_type": "prometheus", "component_name": "prometheus"}
125+
2021-03-21T16:11:11.009Z INFO builder/receivers_builder.go:70 Receiver is starting... {"component_kind": "receiver", "component_type": "k8s_cluster", "component_name": "k8s_cluster"}
126+
2021-03-21T16:11:11.009Z INFO [email protected]/watcher.go:195 Configured Kubernetes MetadataExporter {"component_kind": "receiver", "component_type": "k8s_cluster", "component_name": "k8s_cluster", "exporter_name": "signalfx"}
127+
2021-03-21T16:11:11.009Z INFO builder/receivers_builder.go:75 Receiver started. {"component_kind": "receiver", "component_type": "k8s_cluster", "component_name": "k8s_cluster"}
128+
2021-03-21T16:11:11.009Z INFO healthcheck/handler.go:128 Health Check state change {"component_kind": "extension", "component_type": "health_check", "component_name": "health_check", "status": "ready"}
129+
2021-03-21T16:11:11.009Z INFO service/service.go:267 Everything is ready. Begin running and processing data.
130+
2021-03-21T16:11:11.009Z INFO [email protected]/receiver.go:59 Starting shared informers and wait for initial cache sync. {"component_kind": "receiver", "component_type": "k8s_cluster", "component_name": "k8s_cluster"}
131+
2021-03-21T16:11:11.281Z INFO [email protected]/receiver.go:75 Completed syncing shared informer caches. {"component_kind": "receiver", "component_type": "k8s_cluster", "component_name": "k8s_cluster"}
132+
```
133+
134+
{{% /tab %}}
135+
{{< /tabs >}}
136+
137+
>[!INFO] Deleting a failed installation
138+
>If you make an error installing the OpenTelemetry Collector you can start over by deleting the
139+
>installation with the following command:
140+
>
141+
>``` bash
142+
>helm delete splunk-otel-collector
143+
>```

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

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,8 @@
22

33
title: Deploy the Splunk OpenTelemetry Collector
44
linkTitle: 1. Deploy OpenTelemetry Collector
5-
weight: 2
5+
weight: 1
6+
draft: true
67
---
78

89
To get Observability signals (**metrics, traces** and **logs**) into **Splunk Observability Cloud** the Splunk OpenTelemetry Collector needs to be deployed into the Kubernetes cluster.
@@ -35,6 +36,7 @@ Update Complete. ⎈Happy Helming!⎈
3536

3637
**Splunk Observability Cloud** offers wizards in the UI to walk you through the setup of the OpenTelemetry Collector on Kubernetes, but in the interest of time, we will use the Helm install command below. Additional parameters are set to enable the operator and automatic discovery and configuration.
3738

39+
* `--set="operatorcrds.install=true"` - 0.116.0 and later: Users must now explicitly configure their preferred CRD deployment by enabling a newly added value `operatorcrds.install`.
3840
* `--set="operator.enabled=true"` - this will install the Opentelemetry operator that will be used to handle automatic discovery and configuration.
3941
* `--set="certmanager.enabled=true"` - this will install the required certificate manager for the operator.
4042
* `--set="splunkObservability.profilingEnabled=true"` - this enables Code Profiling via the operator.
@@ -46,6 +48,7 @@ To install the collector run the following command, do **NOT** edit this:
4648

4749
```bash
4850
helm install splunk-otel-collector --version {{< otel-version >}} \
51+
--set="operatorcrds.install=true", \
4952
--set="operator.enabled=true", \
5053
--set="certmanager.enabled=true", \
5154
--set="splunkObservability.realm=$REALM" \

0 commit comments

Comments
 (0)