Skip to content

Commit d670455

Browse files
authored
Merge pull request #2488 from splunk/bhillmer-scenario-cleanup
scenario cleanup
2 parents f7dc13e + 1ae52c6 commit d670455

File tree

3 files changed

+137
-106
lines changed

3 files changed

+137
-106
lines changed

scenarios-tutorials/scenario-collector.rst

Lines changed: 41 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -13,15 +13,22 @@ PonyBank uses Splunk Observability Cloud, which brings data in through the open-
1313

1414
To instrument their infrastructure using the Splunk OTel Collector, Kai takes the following steps:
1515

16-
#. :ref:`set-up-eks-monitoring`
17-
#. :ref:`instrument-ec2-instances`
18-
#. :ref:`instrument-java-svc`
19-
#. :ref:`related-content-use-case`
20-
21-
.. _set-up-eks-monitoring:
22-
23-
Enable EKS monitoring using custom Helm charts
24-
============================================================
16+
.. raw:: html
17+
18+
<embed>
19+
<ol>
20+
<li><a href="#set-up-eks-monitoring">Enable EKS monitoring using custom Helm charts</a></li>
21+
<li><a href="#instrument-ec2-instances">Use the Collector to instrument all EC2 instances</a></li>
22+
<li><a href="#instrument-java-svc">Instrument the Java service for Splunk APM</a></li>
23+
<li><a href="#related-content-use-case">Explore links between telemetry using Related Content</a></li>
24+
</ol>
25+
</embed>
26+
27+
.. raw:: html
28+
29+
<embed>
30+
<h2>Enable EKS monitoring using custom Helm charts<a name="set-up-eks-monitoring" class="headerlink" href="#set-up-eks-monitoring" title="Permalink to this headline">¶</a></h2>
31+
</embed>
2532

2633
Since their migration to the cloud, the PonyBank application has been running in EKS. Kai starts by setting up the cloud integration from Splunk Observability Cloud using the guided setup, which they access from the home page. Guided setups allow Kai to select the relevant ingest token, and generate installation commands and configuration snippets from the selected options, which Kai can use to quickly deploy instrumentation.
2734

@@ -35,10 +42,11 @@ At the end of the guided setup, Kai enters the Kubernetes map of Infrastructure
3542
.. image:: /_images/collector/image1.png
3643
:alt: Cluster view of the Kubernetes infrastructure in Infrastructure Monitoring
3744

38-
.. _instrument-ec2-instances:
39-
40-
Use the Collector to instrument all EC2 instances
41-
============================================================
45+
.. raw:: html
46+
47+
<embed>
48+
<h2>Use the Collector to instrument all EC2 instances<a name="instrument-ec2-instances" class="headerlink" href="#instrument-ec2-instances" title="Permalink to this headline">¶</a></h2>
49+
</embed>
4250

4351
For the hosts managed by IT as Elastic Compute Cloud (EC2) instances, Kai decides to deploy the Splunk OTel Collector using the existing Puppet setup at PonyBank. They open the guided setup for Linux monitoring in Splunk Observability Cloud and select the Puppet tab. After filling out the required information, Kai only has to follow two steps:
4452

@@ -66,10 +74,11 @@ At the same time, Kai can also see logs coming from each host and node in Splunk
6674
.. image:: /_images/collector/image6.png
6775
:alt: Log Observer showing host logs
6876

69-
.. _instrument-java-svc:
70-
71-
Instrument the Java service for Splunk APM
72-
======================================================================================
77+
.. raw:: html
78+
79+
<embed>
80+
<h2>Instrument the Java service for Splunk APM<a name="instrument-java-svc" class="headerlink" href="#instrument-java-svc" title="Permalink to this headline">¶</a></h2>
81+
</embed>
7382

7483
Kai's final goal is to instrument the corporate Java service of PonyBank for Splunk APM, so that the team can analyze spans and traces in Splunk Observability Cloud, as well as use AlwaysOn Profiling to quickly identify inefficient code that's using too much CPU or memory.
7584

@@ -85,10 +94,11 @@ For the EC2 instances that also contain Java services, Kai uses the same guided
8594
.. image:: /_images/collector/install-java-agent.gif
8695
:alt: Console output of the Java agent install
8796

88-
.. _related-content-use-case:
89-
90-
Explore links between telemetry using Related Content
91-
=====================================================================================
97+
.. raw:: html
98+
99+
<embed>
100+
<h2>Explore links between telemetry using Related Content<a name="related-content-use-case" class="headerlink" href="#related-content-use-case" title="Permalink to this headline">¶</a></h2>
101+
</embed>
92102

93103
Thanks to the Related Content feature, when Kai selects the node running the checkout service of the application, the service appears as a link to Splunk APM in the related content bar.
94104

@@ -100,13 +110,19 @@ The same happens when Kai opens Splunk APM and selects the checkout service in t
100110
.. image:: /_images/collector/image4.png
101111
:alt: Application Monitoring showing the Related Content bar
102112

103-
Summary
104-
==================
113+
.. raw:: html
114+
115+
<embed>
116+
<h2>Summary</h2>
117+
</embed>
105118

106119
Kai used Splunk OTel Collector to instrument PonyBank's entire cloud infrastructure, quickly obtaining configuration files and commands for each environment and situation. Through the Java instrumentation for APM, they also retrieved traces from the Java services running on the EKS clusters with related content available to access.
107120

108-
Learn more
109-
=================
121+
.. raw:: html
122+
123+
<embed>
124+
<h2>Learn more</h2>
125+
</embed>
110126

111127
- Learn about sending data to Splunk Observability Cloud in :ref:`get-started-get-data-in`.
112128
- To collect infrastructure metrics and logs from multiple platforms, see :ref:`otel-intro`.

scenarios-tutorials/scenario-landing.rst

Lines changed: 16 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,8 @@ This is the collection of scenarios available for Splunk Observability Cloud. Us
2727
- :ref:`scenario-security`
2828
* - :ref:`OpenTelemetry <otel-intro>`
2929
- :ref:`otel-collector-scenario`
30+
* - :ref:`OpenTelemetry <otel-intro>`
31+
- :ref:`deployments-fargate-java`
3032
* - :ref:`Alerts and detectors <scenarios-alerts-detectors>`
3133
- :ref:`monitor-server-latency`
3234
* - :ref:`Alerts and detectors <scenarios-alerts-detectors>`
@@ -35,8 +37,16 @@ This is the collection of scenarios available for Splunk Observability Cloud. Us
3537
- :ref:`find-detectors`
3638
* - :ref:`Alerts and detectors <scenarios-alerts-detectors>`
3739
- :ref:`troubleshoot-noisy-detectors`
40+
* - :ref:`Alerts and detectors <scenarios-alerts-detectors>`
41+
- :ref:`min-delay-detectors-scenario`
42+
* - :ref:`Alerts and detectors <scenarios-alerts-detectors>`
43+
- :ref:`max-delay-detectors-scenario`
44+
* - :ref:`SLOs <slo-intro>`
45+
- :ref:`custom-metric-slo-scenario`
3846
* - :ref:`APM <apm-scenarios-intro>`
3947
- :ref:`service-map`
48+
* - :ref:`APM <apm-scenarios-intro>`
49+
- :ref:`specific-trace`
4050
* - :ref:`APM <apm-scenarios-intro>`
4151
- :ref:`services-impact-business-workflows`
4252
* - :ref:`APM <apm-scenarios-intro>`
@@ -45,6 +55,8 @@ This is the collection of scenarios available for Splunk Observability Cloud. Us
4555
- :ref:`troubleshoot-business-workflows`
4656
* - :ref:`APM <apm-scenarios-intro>`
4757
- :ref:`apm-scenario-trace-analyzer`
58+
* - :ref:`APM <apm-scenarios-intro>`
59+
- :ref:`apm-scenario-trace-analyzer-trace-duration`
4860
* - :ref:`APM <apm-scenarios-intro>`
4961
- :ref:`monitor-services`
5062
* - :ref:`APM <apm-scenarios-intro>`
@@ -65,10 +77,12 @@ This is the collection of scenarios available for Splunk Observability Cloud. Us
6577
- :ref:`profiling-scenario`
6678
* - :ref:`APM Profiling <profiling-scenario-landingpage>`
6779
- :ref:`memory-profiling-scenario`
68-
* - :ref:`Infrastructure Monitoring <apm-scenarios-intro>`
80+
* - :ref:`Infrastructure Monitoring <get-started-infrastructure>`
6981
- :ref:`troubleshoot-k8s-nav-scenario`
70-
* - :ref:`Infrastructure Monitoring <apm-scenarios-intro>`
82+
* - :ref:`Infrastructure: Metrics pipeline management <metrics-pipeline-intro>`
7183
- :ref:`aggregate-drop-use-case`
84+
* - :ref:`Infrastructure: Metrics pipeline management <metrics-pipeline-intro>`
85+
- :ref:`use-case-archive`
7286
* - :ref:`Infrastructure Monitoring\: Network Explorer <network-explorer-scenarios>`
7387
- :ref:`find-network-error`
7488
* - :ref:`Infrastructure Monitoring\: Network Explorer <network-explorer-scenarios>`
@@ -83,8 +97,6 @@ This is the collection of scenarios available for Splunk Observability Cloud. Us
8397
- :ref:`scenario-monitoring`
8498
* - :ref:`RUM <scenario-landingpage>`
8599
- :ref:`spa-custom-event`
86-
* - :ref:`RUM <scenario-landingpage>`
87-
- :ref:`rum-identify-span-problems`
88100
* - :ref:`RUM <scenario-landingpage>`
89101
- :ref:`rum-mobile-scenario`
90102
* - :ref:`Synthetic Monitoring <synth-landing>`

0 commit comments

Comments
 (0)