Skip to content

Commit 548c79d

Browse files
first FSI workshop commit
1 parent 6b332e1 commit 548c79d

File tree

106 files changed

+1179
-0
lines changed

Some content is hidden

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

106 files changed

+1179
-0
lines changed
Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
---
2+
title: Workshop Overview
3+
linkTitle: 1. Workshop Overview
4+
weight: 1
5+
archetype: chapter
6+
time: 2 minutes
7+
description: Workshop Overview
8+
---
9+
10+
**Introduction**
11+
The goal of this workshop is to give you hands-on experience troubleshooting an issue using Splunk Observability Cloud to identify its root cause. We’ve provided a fully instrumented microservices-based application that actually mimic a payment workflow that is running on Kubernetes, which sends metrics, traces, and logs to Splunk Observability Cloud for real-time analysis.
12+
13+
**Who Should Attend?**
14+
This workshop is ideal for anyone looking to gain practical knowledge of Splunk Observability. It's designed for individuals with little or no prior experience with the platform.
15+
16+
**What You’ll Need**
17+
All you need is your laptop and a browser with access to external websites. The workshop can be attended either in-person or via Zoom. If you don’t have the Zoom client installed, you can still join using your browser.
18+
19+
**Workshop Overview**
20+
In this 3-hour session, we’ll cover the fundamentals of Splunk Observability—the only platform offering streaming analytics and NoSample Full Fidelity distributed tracing—in an interactive, hands-on setting. Here's what you can expect:
21+
22+
- **OpenTelemetry**
23+
Learn why OpenTelemetry is essential for modern observability and how it enhances visibility into your systems.
24+
25+
- **Tour of the Splunk Observability User Interface**
26+
Take a guided tour of Splunk Observability Cloud’s interface, where we’ll show you how to navigate the five key components: APM, Log Observer, and Infrastructure.
27+
28+
- **Splunk Application Performance Monitoring (APM)**
29+
Gain end-to-end visibility of your customers' request path using APM traces. You’ll explore how telemetry from various services is captured and visualized in Splunk Observability Cloud, helping you detect anomalies and errors.
30+
31+
- **Splunk Log Observer (LO)**
32+
Learn how to leverage the "Related Content" feature to easily navigate between components. In this case, we’ll move from an APM trace to the related logs for deeper insight into issues.
33+
34+
By the end of this session, you'll have gained practical experience with Splunk Observability Cloud and a solid understanding of how to troubleshoot and resolve issues across your application stack.
Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
---
2+
title: What is OpenTelemetry & why should you care?
3+
linkTitle: 2. OpenTelemetry
4+
weight: 2
5+
archetype: chapter
6+
time: 2 minutes
7+
description: Learn about OpenTelemetry and why you should care about it.
8+
---
9+
10+
## OpenTelemetry
11+
12+
With the rise of cloud computing, microservices architectures, and ever-more complex business requirements, the need for Observability has never been greater. Observability is the ability to understand the internal state of a system by examining its outputs. In the context of software, this means being able to understand the internal state of a system by examining its telemetry data, which includes **metrics**, **traces**, and **logs**.
13+
14+
To make a system observable, it must be instrumented. That is, the code must emit traces, metrics, and logs. The instrumented data must then be sent to an Observability back-end such as **Splunk Observability Cloud**.
15+
16+
| Metrics | Traces | Logs |
17+
|:-------:|:------:|:----:|
18+
| _**Do I have a problem?**_ | _**Where is the problem?**_ | _**What is the problem?**_ |
19+
20+
OpenTelemetry does two important things:
21+
22+
* Allows you to **own** the data that you generate rather than be stuck with a proprietary data format or tool.
23+
* Allows you to learn **a single set** of APIs and conventions
24+
25+
These two things combined enable teams and organizations the flexibility they need in today’s modern computing world.
26+
27+
There are a lot of variables to consider when getting started with Observability, including the all-important question: _"How do I get my data into an Observability tool?"_. The industry-wide adoption of OpenTelemetry makes this question easier to answer than ever.
28+
29+
## Why Should You Care?
30+
31+
OpenTelemetry is completely open-source and free to use. In the past, monitoring and Observability tools relied heavily on proprietary agents meaning that the effort required to change or set up additional tooling required a large amount of changes across systems, from the infrastructure level to the application level.
32+
33+
Since OpenTelemetry is vendor-neutral and supported by many industry leaders in the Observability space, adopters can switch between supported Observability tools at any time with minor changes to their instrumentation. This is true regardless of which distribution of OpenTelemetry is used – like with Linux, the various distributions bundle settings and add-ons but are all fundamentally based on the community-driven OpenTelemetry project.
34+
35+
Splunk has fully committed to OpenTelemetry so that our customers can collect and use **ALL** their data, in any type, any structure, from any source, on any scale, and all in real-time. OpenTelemetry is fundamentally changing the monitoring landscape, enabling IT and DevOps teams to bring data to every question and every action. You will experience this during these workshops.
36+
37+
![OpenTelemetry Logo](images/otel.png)
3.44 KB
Loading
Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
---
2+
title: Home Page
3+
linkTitle: 1.1 Home Page
4+
weight: 2
5+
time: 5 minutes
6+
---
7+
8+
After you have registered and logged into Splunk Observability Cloud you will be taken to the home or landing page. Here, you will find several useful features to help you get started.
9+
10+
![home page](../images/home-screen.png)
11+
12+
1. **Explore your data pane:** Displays which integrations are enabled and allows you to add additional integrations if you are an Administrator.
13+
2. **Documentation pane:** Training videos and links to documentation to get you started with Splunk Observability Cloud.
14+
3. **Recents pane:** Recently created/visited dashboards and/or detectors for quick access.
15+
4. **Main Menu pane:** Navigate the components of Splunk Observability Cloud.
16+
5. **Org Switcher:** Easily switch between Organizations (if you are a member of more than one Organization).
17+
6. **Expand/Contract Main Menu:** Expand **>>** / Collapse **<<** the main menu if space is at a premium.
18+
19+
Let's start with our first exercise:
20+
21+
{{% notice title="Exercise" style="green" icon="running" %}}
22+
23+
* Expand the Main Menu and click on **Settings**.
24+
* Check in the **Org Switcher** if you have access to more than one Organization.
25+
26+
{{% /notice %}}
27+
28+
{{% notice title="Tip" style="primary" icon="lightbulb" %}}
29+
If you have used Splunk Observability before, you may be placed in an Organization you have used previously. Make sure you are in the correct workshop organization. Verify this with your instructor if you have access to multiple Organizations.
30+
{{% /notice %}}
31+
32+
{{% notice title="Exercise" style="green" icon="running" %}}
33+
34+
* Click **Onboarding Guidance** (Here you can toggle the visibility of the onboarding panes. This is useful if you know the product well enough, and can use the space to show more information).
35+
* Hide the Onboarding Content for the **Home Page**.
36+
* At the bottom of the menu, select your preferred appearance: **Light**, **Dark** or **Auto** mode.
37+
* Did you also notice this is where the **Sign Out** option is? Please don't 😊 !
38+
* Click **<** to get back to the main menu.
39+
40+
{{% /notice %}}
41+
42+
Next, let's check out **Splunk Real User Monitoring (RUM)**.
Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
---
2+
title: Log on FAQ
3+
weight: 99
4+
hidden: true
5+
---
6+
7+
This FAQ will address some of the more common issues we have encountered when logging into the Workshop.
8+
9+
### 1. Invite email or password renewal email not arriving
10+
11+
The first step to take is to search for an email from **<[email protected]>**, across all your email folders, as this is the address used to send the invite and password renewal emails. If you don't see the email, check your spam/junk folder.
12+
13+
If you are sure the email does not exist your email, ask the Instructor to verify the email used for the workshop and have him/her resend the invite.
14+
15+
If this fails, another solution is to provide the Instructor with a different email address (private e-mail address for example) and have him/her resend the invite.
16+
17+
---
18+
19+
### 2. Password not accepted
20+
21+
The requirements for a password in Splunk Observability Cloud are:
22+
23+
* **Must** be between 8 and 32 characters
24+
* **Must** contain at least one capital letter
25+
* **Must** have at least one number
26+
* **Must** have at least one symbol (e.g. !@#$%^&*()_+)
27+
28+
---
29+
30+
### 3. Invalid or unknown password
31+
32+
The system does not recognize the password and username combination, please click on the reset password link to try and reset your password.
33+
You will be asked to provide a password. If that account exists, an email will be sent to allow you to reset your password. follow the instructions in that email.
34+
35+
If no email arrives or your username is not recognized, reach out to your instructor for assistance.
36+
37+
---
38+
39+
### 4. Other options
40+
41+
To Be Completed.
Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
---
2+
title: Getting Started
3+
linkTitle: 1. Getting Started
4+
weight: 1
5+
time: 2 minutes
6+
description: Learn how to get started with Splunk Observability Cloud.
7+
---
8+
9+
### 1. Sign in to Splunk Observability Cloud
10+
11+
You should have received an e-mail from Splunk inviting you to the Workshop Org. This e-mail will look like the screenshot below, if you cannot find it, please check your Spam/Junk folders or inform your Instructor. You can also check for other solutions in our [**login F.A.Q.**](99-login-faq).
12+
13+
To proceed click the **Join Now** button or click on the link provided in the e-mail.
14+
15+
If you have already completed the registration process you can skip the rest and proceed directly to Splunk Observability Cloud and log in:
16+
17+
* [**https://app.eu0.signalfx.com (EMEA)**](https://app.eu0.signalfx.com)
18+
* [**https://app.us1.signalfx.com (APAC/AMER)**](https://app.us1.signalfx.com)
19+
20+
![email](images/invite-email.png?width=25vw)
21+
22+
If this is your first time using Splunk Observability Cloud, you will be presented with the registration form. Enter your full name, and desired password. Please note that the password requirements are:
23+
24+
* **Must** be between 8 and 32 characters
25+
* **Must** contain at least one capital letter
26+
* **Must** have at least one number
27+
* **Must** have at least one symbol (e.g. !@#$%^&*()_+)
28+
29+
Click the checkbox to agree to the terms and conditions and click the **SIGN IN NOW** button.
30+
31+
![User-Setup](images/enter-password.png?width=25vw)
43.7 KB
Loading
731 KB
Loading
163 KB
Loading
Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
---
2+
title: Application Performance Monitoring Home page
3+
linkTitle: 2.1 APM Home Page
4+
weight: 2
5+
---
6+
7+
Click **APM** in the main menu, the APM Home Page is made up of 3 distinct sections:
8+
9+
![APM page](../images/apm-main.png)
10+
11+
1. **Onboarding Pane Pane:** Training videos and links to documentation to get you started with Splunk APM.
12+
2. **APM Overview Pane:** Real-time metrics for the Top Services and Top Business Workflows.
13+
3. **Functions Pane:** Links for deeper analysis of your services, tags, traces, database query performance and code profiling.
14+
15+
The **APM Overview** pan provides a high-level view of the health of your application. It includes a summary of the services, latency and errors in your application. It also includes a list of the top services by error rate and the top business workflows by error rate (a business workflow is the start-to-finish journey of the collection of traces associated with a given activity or transaction and enables monitoring of end-to-end KPIs and identifying root causes and bottlenecks).
16+
17+
{{% notice title=" About Environments" style="info" %}}
18+
19+
To easily differentiate between multiple applications, Splunk uses **environments**. The naming convention for workshop environments is **[NAME OF WORKSHOP]-workshop**. Your instructor will provide you with the correct one to select.
20+
21+
{{% /notice %}}
22+
23+
{{% notice title="Exercise" style="green" icon="running" %}}
24+
25+
* Verify that the time window we are working with is set to the last 15 minutes (**-15m**).
26+
* Change the environment to the workshop one by selecting its name from the drop-down box and make sure that is the only one selected.
27+
{{< tabs >}}
28+
{{% tab title="Question" %}}
29+
**What can you conclude from the *Top Services by Error Rate* chart?**
30+
{{% /tab %}}
31+
{{% tab title="Answer" %}}
32+
**The *paymentservice* has a high error rate**
33+
{{% /tab %}}
34+
{{< /tabs >}}
35+
<!--
36+
* Click on the Explore Tile in the Function Pane. This will bring us to the automatically generated map of our services. This map shows how the services interact together based on the trace data being sent to Splunk Observability Cloud.
37+
-->
38+
{{% /notice %}}
39+
40+
If you scroll down the Overview Page you will notice some services listed have **Inferred Service** next to them.
41+
42+
Splunk APM can infer the presence of the remote service, or inferred service if the span calling the remote service has the necessary information. Examples of possible inferred services include databases, HTTP endpoints, and message queues. Inferred services are not instrumented, but they are displayed on the service map and the service list.
43+
44+
Next, let's check out **Splunk Log Observer (LO)**.

0 commit comments

Comments
 (0)