Merge pull request #314 from dmitchsplunk/main

renamed the understand impact of changes to debug problems in microse…
splunk · Sep 9, 2024 · 3461fac · 3461fac
2 parents 17383cc + 914bd94
commit 3461fac
Show file tree

Hide file tree

Showing 77 changed files with 41 additions and 34 deletions.
diff --git a/content/en/scenarios/debug_problems/_index.md b/content/en/scenarios/debug_problems/_index.md
@@ -2,36 +2,8 @@
 title: Debug Problems in Microservices
 linkTitle: Debug Problems in Microservices
 weight: 3
-archetype: chapter
-time: 2 minutes
-authors: ["Derek Mitchell"]
-description: This scenario helps software developers to make debugging problems in microservices easier, faster, and more cost-effective for platform engineering teams rolling out standardized tooling. 
-
+description: This scenario helps engineering teams identify and fix issues caused by planned and unplanned changes to their microservices-based applications.
 
 ---
 
-**Service Maps** and **Traces** are extremely valuable in determining what service an issue resides in.  And related log data helps provide detail on why issues are occurring in that service.  
-
-But engineers sometimes need to go even deeper to debug a problem that’s occurring in one of their services.  
-
-This is where features such as Splunk's **AlwaysOn Profiling** and **Database Query Performance** come in.
-
-**AlwaysOn Profiling** continuously collects stack traces so that you can discover which lines in your code are consuming the most CPU and memory.  
-
-And **Database Query Performance** can quickly identify long-running, unoptimized, or heavy queries and mitigate issues they might be causing. 
-
-In this workshop, we'll explore:
-
-* How to debug an application with several performance issues. 
-* How to use **Database Query Performance** to find slow-running queries that impact application performance. 
-* How to enable **AlwaysOn Profiling** and use it to find the code that consumes the most CPU and memory. 
-* How to apply fixes based on findings from **Splunk Observability Cloud** and verify the result. 
-
-The workshop uses a Java-based application called `The Door Game` hosted in Kubernetes. Let's get started!
-
-{{% notice title="Tip" style="primary"  icon="lightbulb" %}}
-The easiest way to navigate through this workshop is by using:
-
-* the left/right arrows (**<** | **>**) on the top right of this page
-* the left (◀️) and right (▶️) cursor keys on your keyboard
-  {{% /notice %}}
+{{% children description="true" %}}
diff --git a/...ios/debug_problems/1-build-application.md → ...problems/profiling/1-build-application.md b/...ios/debug_problems/1-build-application.md → ...problems/profiling/1-build-application.md
diff --git a/...g_problems/2-troubleshoot-game-startup.md → .../profiling/2-troubleshoot-game-startup.md b/...g_problems/2-troubleshoot-game-startup.md → .../profiling/2-troubleshoot-game-startup.md
diff --git a/...rios/debug_problems/3-enable-profiling.md → ..._problems/profiling/3-enable-profiling.md b/...rios/debug_problems/3-enable-profiling.md → ..._problems/profiling/3-enable-profiling.md
diff --git a/...ug_problems/4-fix-app-startup-slowness.md → ...s/profiling/4-fix-app-startup-slowness.md b/...ug_problems/4-fix-app-startup-slowness.md → ...s/profiling/4-fix-app-startup-slowness.md
diff --git a/...s/debug_problems/5-fix-ingame-slowness.md → ...oblems/profiling/5-fix-ingame-slowness.md b/...s/debug_problems/5-fix-ingame-slowness.md → ...oblems/profiling/5-fix-ingame-slowness.md
diff --git a/.../en/scenarios/debug_problems/6-summary.md → ...ios/debug_problems/profiling/6-summary.md b/.../en/scenarios/debug_problems/6-summary.md → ...ios/debug_problems/profiling/6-summary.md
diff --git a/content/en/scenarios/debug_problems/profiling/_index.md b/content/en/scenarios/debug_problems/profiling/_index.md
@@ -0,0 +1,36 @@
+---
+title: Profiling Workshop
+linkTitle: Profiling Workshop
+weight: 3
+archetype: chapter
+time: 2 minutes
+authors: ["Derek Mitchell"]
+description: This workshop shows how Database Query Performance and AlwaysOn Profiling can be used to reduce the time required for engineers to debug problems in microservices. 
+
+---
+
+**Service Maps** and **Traces** are extremely valuable in determining what service an issue resides in.  And related log data helps provide detail on why issues are occurring in that service.  
+
+But engineers sometimes need to go even deeper to debug a problem that’s occurring in one of their services.  
+
+This is where features such as Splunk's **AlwaysOn Profiling** and **Database Query Performance** come in.
+
+**AlwaysOn Profiling** continuously collects stack traces so that you can discover which lines in your code are consuming the most CPU and memory.  
+
+And **Database Query Performance** can quickly identify long-running, unoptimized, or heavy queries and mitigate issues they might be causing. 
+
+In this workshop, we'll explore:
+
+* How to debug an application with several performance issues. 
+* How to use **Database Query Performance** to find slow-running queries that impact application performance. 
+* How to enable **AlwaysOn Profiling** and use it to find the code that consumes the most CPU and memory. 
+* How to apply fixes based on findings from **Splunk Observability Cloud** and verify the result. 
+
+The workshop uses a Java-based application called `The Door Game` hosted in Kubernetes. Let's get started!
+
+{{% notice title="Tip" style="primary"  icon="lightbulb" %}}
+The easiest way to navigate through this workshop is by using:
+
+* the left/right arrows (**<** | **>**) on the top right of this page
+* the left (◀️) and right (▶️) cursor keys on your keyboard
+  {{% /notice %}}
diff --git a/...g_problems/images/always-on-profiling.png → .../profiling/images/always-on-profiling.png b/...g_problems/images/always-on-profiling.png → .../profiling/images/always-on-profiling.png
diff --git a/...os/debug_problems/images/apm_overview.png → ...roblems/profiling/images/apm_overview.png b/...os/debug_problems/images/apm_overview.png → ...roblems/profiling/images/apm_overview.png
diff --git a/..._problems/images/db_query_performance.png → ...profiling/images/db_query_performance.png b/..._problems/images/db_query_performance.png → ...profiling/images/db_query_performance.png
diff --git a/...problems/images/door_game_choose_door.png → ...rofiling/images/door_game_choose_door.png b/...problems/images/door_game_choose_door.png → ...rofiling/images/door_game_choose_door.png
diff --git a/...blems/images/door_game_initial_screen.png → ...iling/images/door_game_initial_screen.png b/...blems/images/door_game_initial_screen.png → ...iling/images/door_game_initial_screen.png
diff --git a/..._problems/images/flamegraph_and_table.png → ...profiling/images/flamegraph_and_table.png b/..._problems/images/flamegraph_and_table.png → ...profiling/images/flamegraph_and_table.png
diff --git a/...arios/debug_problems/images/lets_play.png → ...g_problems/profiling/images/lets_play.png b/...arios/debug_problems/images/lets_play.png → ...g_problems/profiling/images/lets_play.png
diff --git a/...images/memory_allocation_stack_traces.png → ...images/memory_allocation_stack_traces.png b/...images/memory_allocation_stack_traces.png → ...images/memory_allocation_stack_traces.png
diff --git a/...ebug_problems/images/memory_profiling.png → ...ems/profiling/images/memory_profiling.png b/...ebug_problems/images/memory_profiling.png → ...ems/profiling/images/memory_profiling.png
diff --git a/...debug_problems/images/new_game_traces.png → ...lems/profiling/images/new_game_traces.png b/...debug_problems/images/new_game_traces.png → ...lems/profiling/images/new_game_traces.png
diff --git a/...ios/debug_problems/images/service_map.png → ...problems/profiling/images/service_map.png b/...ios/debug_problems/images/service_map.png → ...problems/profiling/images/service_map.png
diff --git a/...rios/debug_problems/images/slow_trace.png → ..._problems/profiling/images/slow_trace.png b/...rios/debug_problems/images/slow_trace.png → ..._problems/profiling/images/slow_trace.png
diff --git a/...ebug_problems/images/span_with_stacks.png → ...ems/profiling/images/span_with_stacks.png b/...ebug_problems/images/span_with_stacks.png → ...ems/profiling/images/span_with_stacks.png
diff --git a/...roblems/images/trace_with_call_stacks.png → ...ofiling/images/trace_with_call_stacks.png b/...roblems/images/trace_with_call_stacks.png → ...ofiling/images/trace_with_call_stacks.png
diff --git a/...ems/images/trace_with_cpu_call_stacks.png → ...ing/images/trace_with_cpu_call_stacks.png b/...ems/images/trace_with_cpu_call_stacks.png → ...ing/images/trace_with_cpu_call_stacks.png
diff --git a/...problems/images/trace_with_slow_query.png → ...rofiling/images/trace_with_slow_query.png b/...problems/images/trace_with_slow_query.png → ...rofiling/images/trace_with_slow_query.png
diff --git a/...cenarios/debug_problems/images/traces.png → ...ebug_problems/profiling/images/traces.png b/...cenarios/debug_problems/images/traces.png → ...ebug_problems/profiling/images/traces.png
diff --git a/...roblems/images/traces_with_slow_query.png → ...ofiling/images/traces_with_slow_query.png b/...roblems/images/traces_with_slow_query.png → ...ofiling/images/traces_with_slow_query.png
diff --git a/...ug_problems/images/view_stack_on_span.png → ...s/profiling/images/view_stack_on_span.png b/...ug_problems/images/view_stack_on_span.png → ...s/profiling/images/view_stack_on_span.png
diff --git a/..._impact_of_changes/1-build-application.md → ...g_problems/tagging/1-build-application.md b/..._impact_of_changes/1-build-application.md → ...g_problems/tagging/1-build-application.md
diff --git a/...tand_impact_of_changes/2-what-are-tags.md → ...debug_problems/tagging/2-what-are-tags.md b/...tand_impact_of_changes/2-what-are-tags.md → ...debug_problems/tagging/2-what-are-tags.md
diff --git a/...ges/3-capture-tags/1-capture-tags-java.md → ...ing/3-capture-tags/1-capture-tags-java.md b/...ges/3-capture-tags/1-capture-tags-java.md → ...ing/3-capture-tags/1-capture-tags-java.md
diff --git a/...s/3-capture-tags/2-capture-tags-python.md → ...g/3-capture-tags/2-capture-tags-python.md b/...s/3-capture-tags/2-capture-tags-python.md → ...g/3-capture-tags/2-capture-tags-python.md
diff --git a/...mpact_of_changes/3-capture-tags/_index.md → ...problems/tagging/3-capture-tags/_index.md b/...mpact_of_changes/3-capture-tags/_index.md → ...problems/tagging/3-capture-tags/_index.md
diff --git a/...impact_of_changes/4-explore-trace-data.md → ..._problems/tagging/4-explore-trace-data.md b/...impact_of_changes/4-explore-trace-data.md → ..._problems/tagging/4-explore-trace-data.md
diff --git a/...erstand_impact_of_changes/5-index-tags.md → ...os/debug_problems/tagging/5-index-tags.md b/...erstand_impact_of_changes/5-index-tags.md → ...os/debug_problems/tagging/5-index-tags.md
diff --git a/...nderstand_impact_of_changes/6-use-tags.md → ...rios/debug_problems/tagging/6-use-tags.md b/...nderstand_impact_of_changes/6-use-tags.md → ...rios/debug_problems/tagging/6-use-tags.md
diff --git a/...-alerting-dashboards-slos/1-dashboards.md → ...-alerting-dashboards-slos/1-dashboards.md b/...-alerting-dashboards-slos/1-dashboards.md → ...-alerting-dashboards-slos/1-dashboards.md
diff --git a/.../7-alerting-dashboards-slos/2-alerting.md → .../7-alerting-dashboards-slos/2-alerting.md b/.../7-alerting-dashboards-slos/2-alerting.md → .../7-alerting-dashboards-slos/2-alerting.md
diff --git a/...nges/7-alerting-dashboards-slos/3-slos.md → ...ging/7-alerting-dashboards-slos/3-slos.md b/...nges/7-alerting-dashboards-slos/3-slos.md → ...ging/7-alerting-dashboards-slos/3-slos.md
diff --git a/...nges/7-alerting-dashboards-slos/_index.md → ...ging/7-alerting-dashboards-slos/_index.md b/...nges/7-alerting-dashboards-slos/_index.md → ...ging/7-alerting-dashboards-slos/_index.md
diff --git a/...understand_impact_of_changes/8-summary.md → ...arios/debug_problems/tagging/8-summary.md b/...understand_impact_of_changes/8-summary.md → ...arios/debug_problems/tagging/8-summary.md
diff --git a/...os/understand_impact_of_changes/_index.md → ...cenarios/debug_problems/tagging/_index.md b/...os/understand_impact_of_changes/_index.md → ...cenarios/debug_problems/tagging/_index.md
@@ -1,12 +1,11 @@
 ---
-title: Understand Impact of Changes
-linkTitle: Understand Impact of Changes
+title: Tagging Workshop
+linkTitle: Tagging Workshop
 weight: 2
 archetype: chapter
 time: 2 minutes
 authors: ["Derek Mitchell"]
-description: This scenario helps SREs identify the impact of planned and unplanned changes to their environment so that they can address issues quickly to ensure the performance of key customer transactions.
-
+description: This workshop shows how tags can be used to reduce the time required for SREs to isolate issues across services, so they know which team to engage to troubleshoot the issue further, and can provide context to help engineering get a head start on debugging.
 
 ---
 

diff --git a/...s/images/alert_condition_suddenchange.png → ...g/images/alert_condition_suddenchange.png b/...s/images/alert_condition_suddenchange.png → ...g/images/alert_condition_suddenchange.png
diff --git a/...impact_of_changes/images/apm_overview.png → ..._problems/tagging/images/apm_overview.png b/...impact_of_changes/images/apm_overview.png → ..._problems/tagging/images/apm_overview.png
diff --git a/...pact_of_changes/images/chart_settings.png → ...roblems/tagging/images/chart_settings.png b/...pact_of_changes/images/chart_settings.png → ...roblems/tagging/images/chart_settings.png
diff --git a/..._of_changes/images/chart_with_seconds.png → ...ems/tagging/images/chart_with_seconds.png b/..._of_changes/images/chart_with_seconds.png → ...ems/tagging/images/chart_with_seconds.png
diff --git a/...ct_of_changes/images/create_dashboard.png → ...blems/tagging/images/create_dashboard.png b/...ct_of_changes/images/create_dashboard.png → ...blems/tagging/images/create_dashboard.png
diff --git a/...of_changes/images/create_new_detector.png → ...ms/tagging/images/create_new_detector.png b/...of_changes/images/create_new_detector.png → ...ms/tagging/images/create_new_detector.png
diff --git a/...ges/create_troubleshooting_metric_set.png → ...ges/create_troubleshooting_metric_set.png b/...ges/create_troubleshooting_metric_set.png → ...ges/create_troubleshooting_metric_set.png
diff --git a/...images/credit_check_service_dashboard.png → ...images/credit_check_service_dashboard.png b/...images/credit_check_service_dashboard.png → ...images/credit_check_service_dashboard.png
diff --git a/...images/credit_score_starts_with_seven.png → ...images/credit_score_starts_with_seven.png b/...images/credit_score_starts_with_seven.png → ...images/credit_score_starts_with_seven.png
diff --git a/...anges/images/duration_by_credit_score.png → ...gging/images/duration_by_credit_score.png b/...anges/images/duration_by_credit_score.png → ...gging/images/duration_by_credit_score.png
diff --git a/..._of_changes/images/edit_apm_metricset.png → ...ems/tagging/images/edit_apm_metricset.png b/..._of_changes/images/edit_apm_metricset.png → ...ems/tagging/images/edit_apm_metricset.png
diff --git a/..._impact_of_changes/images/error_trace.png → ...g_problems/tagging/images/error_trace.png b/..._impact_of_changes/images/error_trace.png → ...g_problems/tagging/images/error_trace.png
diff --git a/..._of_changes/images/long_running_trace.png → ...ems/tagging/images/long_running_trace.png b/..._of_changes/images/long_running_trace.png → ...ems/tagging/images/long_running_trace.png
diff --git a/...mpact_of_changes/images/metric_finder.png → ...problems/tagging/images/metric_finder.png b/...mpact_of_changes/images/metric_finder.png → ...problems/tagging/images/metric_finder.png
diff --git a/...anges/images/metricset_config_applied.png → ...gging/images/metricset_config_applied.png b/...anges/images/metricset_config_applied.png → ...gging/images/metricset_config_applied.png
diff --git a/...f_changes/images/monitoring_metricset.png → ...s/tagging/images/monitoring_metricset.png b/...f_changes/images/monitoring_metricset.png → ...s/tagging/images/monitoring_metricset.png
diff --git a/...hanges/images/new_detector_from_chart.png → ...agging/images/new_detector_from_chart.png b/...hanges/images/new_detector_from_chart.png → ...agging/images/new_detector_from_chart.png
diff --git a/..._of_changes/images/pending_metric_set.png → ...ems/tagging/images/pending_metric_set.png b/..._of_changes/images/pending_metric_set.png → ...ems/tagging/images/pending_metric_set.png
diff --git a/...mpact_of_changes/images/save_chart_as.png → ...problems/tagging/images/save_chart_as.png b/...mpact_of_changes/images/save_chart_as.png → ...problems/tagging/images/save_chart_as.png
diff --git a/..._impact_of_changes/images/service_map.png → ...g_problems/tagging/images/service_map.png b/..._impact_of_changes/images/service_map.png → ...g_problems/tagging/images/service_map.png
diff --git a/..._changes/images/service_map_breakdown.png → .../tagging/images/service_map_breakdown.png b/..._changes/images/service_map_breakdown.png → .../tagging/images/service_map_breakdown.png
diff --git a/...images/service_request_duration_chart.png → ...images/service_request_duration_chart.png b/...images/service_request_duration_chart.png → ...images/service_request_duration_chart.png
diff --git a/...impact_of_changes/images/slo_0_create.png → ..._problems/tagging/images/slo_0_create.png b/...impact_of_changes/images/slo_0_create.png → ..._problems/tagging/images/slo_0_create.png
diff --git a/...impact_of_changes/images/slo_1_choose.png → ..._problems/tagging/images/slo_1_choose.png b/...impact_of_changes/images/slo_1_choose.png → ..._problems/tagging/images/slo_1_choose.png
diff --git a/...changes/images/slo_2_define_objective.png → ...tagging/images/slo_2_define_objective.png b/...changes/images/slo_2_define_objective.png → ...tagging/images/slo_2_define_objective.png
diff --git a/..._changes/images/slo_3_define_alerting.png → .../tagging/images/slo_3_define_alerting.png b/..._changes/images/slo_3_define_alerting.png → .../tagging/images/slo_3_define_alerting.png
diff --git a/...of_changes/images/slo_4_name_and_save.png → ...ms/tagging/images/slo_4_name_and_save.png b/...of_changes/images/slo_4_name_and_save.png → ...ms/tagging/images/slo_4_name_and_save.png
diff --git a/...f_changes/images/tag_spotlight_errors.png → ...s/tagging/images/tag_spotlight_errors.png b/...f_changes/images/tag_spotlight_errors.png → ...s/tagging/images/tag_spotlight_errors.png
diff --git a/..._changes/images/tag_spotlight_latency.png → .../tagging/images/tag_spotlight_latency.png b/..._changes/images/tag_spotlight_latency.png → .../tagging/images/tag_spotlight_latency.png
diff --git a/..._changes/images/tag_spotlight_preview.png → .../tagging/images/tag_spotlight_preview.png b/..._changes/images/tag_spotlight_preview.png → .../tagging/images/tag_spotlight_preview.png
diff --git a/.../images/tag_spotlight_preview_details.png → .../images/tag_spotlight_preview_details.png b/.../images/tag_spotlight_preview_details.png → .../images/tag_spotlight_preview_details.png
diff --git a/..._changes/images/trace_with_attributes.png → .../tagging/images/trace_with_attributes.png b/..._changes/images/trace_with_attributes.png → .../tagging/images/trace_with_attributes.png
diff --git a/...stand_impact_of_changes/images/traces.png → .../debug_problems/tagging/images/traces.png b/...stand_impact_of_changes/images/traces.png → .../debug_problems/tagging/images/traces.png
diff --git a/..._of_changes/images/traces_errors_only.png → ...ems/tagging/images/traces_errors_only.png b/..._of_changes/images/traces_errors_only.png → ...ems/tagging/images/traces_errors_only.png
diff --git a/..._of_changes/images/traces_with_errors.png → ...ems/tagging/images/traces_with_errors.png b/..._of_changes/images/traces_with_errors.png → ...ems/tagging/images/traces_with_errors.png
diff --git a/...s/images/update_pending_apm_metricset.png → ...g/images/update_pending_apm_metricset.png b/...s/images/update_pending_apm_metricset.png → ...g/images/update_pending_apm_metricset.png