Skip to content

Commit 6b49dca

Browse files
Merge pull request #2687 from splunk/johannahp-O11YDOCS-6428-service-view-updates
APM error based troubleshooting doc updates and service map redesign doc updates
2 parents 433858f + 8027a5a commit 6b49dca

File tree

5 files changed

+24
-12
lines changed

5 files changed

+24
-12
lines changed
1.46 MB
Loading
310 KB
Loading

apm/apm-spans-traces/service-map.rst

Lines changed: 3 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ See :ref:`apm-inferred-services` to learn more about inferred services in APM.
1515

1616
The following screenshot shows an example service map:
1717

18-
.. image:: /_images/apm/spans-traces/service-map-global-search-rename.png
18+
.. image:: /_images/apm/spans-traces/service-map-updated-view.png
1919
:width: 95%
2020
:alt: An example of the service map in Splunk APM Service Map.
2121

@@ -28,6 +28,8 @@ Use these steps to access the service map in Splunk APM:
2828
#. Log into Splunk Observability Cloud.
2929
#. Select :guilabel:`APM` in the navigation bar.
3030
#. Select :guilabel:`Service Map` on the APM landing page. The service map view opens, with the service map in the center.
31+
#. (Optional) Select :guilabel:`Switch to Classic Service Map` to switch to the lateral service map layout. The default constellation view displays a larger view of your environment and helps you quickly assess service performance.
32+
3133

3234
Using the service map, you can do the following:
3335

@@ -86,15 +88,6 @@ When configured, you can select tiles in the Related Content bar to seamlessly n
8688
.. image:: /_images/apm/spans-traces/service-map-related-content-global-search-rename.gif
8789
:alt: Using Related Content in Splunk Observability Cloud.
8890

89-
Configure and view global data links for your service map
90-
==========================================================
91-
92-
You can configure global data links to link Splunk APM properties, such as services, traces, spans, and span tags, to relevant resources. For example, you can link APM properties to Infrastructure Monitoring navigators and dashboards, Splunk instances, Kibana logs, Splunk AppDynamics tiers, or custom URLs.
93-
94-
For information on how to configure data links to display in your service map, see :ref:`apm-create-data-links`. You can also create a global data link directly from the APM :guilabel:`Service Map` by selecting an inferred service, selecting the :guilabel:`(⋯)` menu next to the inferred service name, and selecting :guilabel:`Configure data links`.
95-
96-
For information on how to view data links in your service map, see :ref:`apm-use-data-links`.
97-
9891
Share your view of the service map
9992
======================================
10093
To share your view of the service map with a colleague, copy and share the URL. Your current filter selections are preserved in the URL.

apm/apm-spans-traces/service-view.rst

Lines changed: 20 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ You can also access the service view for a specific service within the service m
2929

3030
Finally, you can also access the service view for a specific service by selecting the service from the APM landing page.
3131

32-
Use the service overview to monitor the health of your service
32+
Use the service view to monitor the health of your service
3333
=====================================================================
3434

3535
When you open the service view an environment is selected based on your recently viewed environments. Adjust the environment and time range filters if necessary. Use the following sections to monitor the health of your service.
@@ -54,6 +54,18 @@ Use the following metrics in the :guilabel:`Service metrics` section to monitor
5454
* Inferred services - un-instrumented third-party services
5555
* Pub/sub queues - Publisher/subscriber queues
5656

57+
Error breakdown
58+
-----------------
59+
60+
Use the following section to troubleshoot service errors and view relevant traces for specific error types. Select a point on the graph to view example traces for a particular data point, or select any value to hide the time series for that value.
61+
62+
.. image:: /_images/apm/spans-traces/service-view-errors.png
63+
:width: 95%
64+
:alt: Screenshot of charts on the service view page that display service errors.
65+
66+
* Errors by exception type - Displays errors with the span attribute ``exception.type``. Select a data point on the chart to view related traces and alert details for that time period.
67+
* Errors by status code - Displays errors based on the HTTP or gRPC error status code. Select a data point on the chart to view related traces and alert details for that selected time period and error. For more information about error status codes, see :new-page:`Semantic Conventions for HTTP Spans <https://opentelemetry.io/docs/specs/semconv/http/http-spans/>`.
68+
5769
Runtime metrics
5870
-----------------
5971

@@ -82,6 +94,13 @@ View Tag Spotlight view for your service
8294

8395
Select :guilabel:`Tag Spotlight` to view Tag Spotlight view filtered for your service. See :ref:`apm-tag-spotlight` to learn more about Tag Spotlight.
8496

97+
View errors for your service
98+
====================================================
99+
100+
Select the :guilabel:`Errors` tab to visualize errors for your service. Select a specific error type to view available traces for that error, and troubleshoot by viewing details such as the ``exception.message`` or ``exception.stacktrace``.
101+
102+
Administrators can pause these metrics by going to the :guilabel:`Sources of Errors MetricSets` section on the :guilabel:`APM MetricSets` page and selecting :guilabel:`Pause Indexing`. These metrics are turned on by default.
103+
85104
View endpoints for your service
86105
=================================
87106

apm/span-tags/tag-spotlight.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ To view service performance broken down by your indexed span tags, follow these
2525
* Select the :guilabel:`Tag Spotlight` panel on the APM landing page or in the service map.
2626
* Select the :guilabel:`Tag Spotlight` tab in the service view for your service.
2727
* Use the search in the top toolbar to search for Tag Spotlight and select the navigation result to go to Tag Spotlight.
28-
#. Add time range, environment, workflow, service, operation, and tag filters as need to refine the data in your Tag Spotlight view. The default time range is for the last 15 minutes, and the data resolution is 10 seconds.
28+
#. Add time range, environment, workflow, service, endpoint, operation, and tag filters as need to refine the data in your Tag Spotlight view. The default time range is for the last 15 minutes, and the data resolution is 10 seconds.
2929
#. Use the request and errors and latency time-series charts at the top to see a distribution of your RED metrics.
3030
#. Use the bar charts under the request and errors and latency time-series charts to view RED metrics for each indexed span tag.
3131
#. View the distribution of all indexed span tags. The tag bar charts display either request and error distributions or latency distribution. Use the :guilabel:`Cards display` menu to select the data you want to display in the bars.

0 commit comments

Comments
 (0)