Skip to content
This repository was archived by the owner on Sep 2, 2025. It is now read-only.

Commit 5f0a9dc

Browse files
gschatz-splunkgschatz-splunk
authored
Merge pull request #2427 from splunk/gschatz-syn-kpis
rearrange for kPI page
2 parents 45062a2 + b4c25f5 commit 5f0a9dc

File tree

5 files changed

+66
-141
lines changed

5 files changed

+66
-141
lines changed

‎index.rst‎

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -743,18 +743,23 @@ To keep up to date with changes in the products, see the Splunk Observability Cl
743743
.. toctree::
744744
:maxdepth: 3
745745

746-
Use a Browser test to test a webpage TOGGLE <synthetics/browser-test/browser-test>
746+
Browser tests for webpages TOGGLE <synthetics/browser-test/browser-test>
747747

748748
.. toctree::
749749
:maxdepth: 3
750750

751-
Use an Uptime test to test port or HTTP uptime TOGGLE <synthetics/uptime-test/uptime-test>
751+
Uptime Tests for port and HTTP TOGGLE <synthetics/uptime-test/uptime-test>
752752

753753
.. toctree::
754754
:maxdepth: 3
755755

756756
Use an API test to test an endpoint TOGGLE <synthetics/api-test/api-test>
757757

758+
.. toctree::
759+
:maxdepth: 3
760+
761+
synthetics/test-kpis/test-kpis
762+
758763
.. toctree::
759764
:maxdepth: 3
760765

‎synthetics/api-test/api-test-results.rst‎

Lines changed: 1 addition & 44 deletions
Original file line numberDiff line numberDiff line change
@@ -27,50 +27,7 @@ On the :guilabel:`Test History` page, view a customizable summary of recent run
2727

2828
Customize the Performance KPIs chart
2929
--------------------------------------------------
30-
The :guilabel:`Performance KPIs` chart offers a customizable visualization of your recent test results. Use these steps to customize the visualization:
31-
32-
In the :guilabel:`Performance KPIs` chart, use the selectors to adjust the following settings:
33-
34-
.. list-table::
35-
:header-rows: 1
36-
:widths: 20 20 60
37-
38-
* - :strong:`Option`
39-
- :strong:`Default`
40-
- :strong:`Description`
41-
42-
* - Time
43-
- Last 8 hours
44-
- Choose the amount of time shown in the chart.
45-
46-
* - Interval
47-
- Run level
48-
- | Interval between each pair of data points.
49-
|
50-
| When you choose :strong:`Run level`, each data point on the chart corresponds to an actual run of the test; choosing larger intervals shows an aggregation of results over that time interval.
51-
|
52-
| If you choose a level higher than :strong:`Run level`, the data points you see are aggregations of multiple runs. You can select an aggregate data point in the chart to zoom in and view the data at a per-run level.
53-
54-
* - Scale
55-
- Linear
56-
- Choose whether the y-axis has a linear or logarithmic scale.
57-
58-
* - Segment by
59-
- Location
60-
- | Choose whether the data points are segmented by run location or no segmentation:
61-
|
62-
| - Choose :strong:`No segmentation` to view data points aggregated from across all locations in your test.
63-
| - Choose :strong:`Location` to compare performance across multiple test locations.
64-
|
65-
| Toggle between these options to see your test data sliced in various ways.
66-
67-
* - Filter
68-
- All options selected
69-
- If you have enabled segmentation, choose the run locations, pages, or transactions you want to display on the chart.
70-
71-
* - Metrics
72-
- Duration
73-
- By default, the chart displays the :guilabel:`Duration` metric. Use the drop-down list to choose the metrics you want to view in the chart.
30+
See :ref:`test-kpis`.
7431

7532

7633
View results for a specific run

‎synthetics/browser-test/browser-test-results.rst‎

Lines changed: 1 addition & 47 deletions
Original file line numberDiff line numberDiff line change
@@ -29,53 +29,7 @@ On the :guilabel:`Test History` page, view a customizable summary of recent run
2929

3030
Customize the Performance KPIs chart
3131
--------------------------------------------------
32-
The :guilabel:`Performance KPIs` chart offers a customizable visualization of your recent test results. Use these steps to customize the visualization:
33-
34-
In the :guilabel:`Performance KPIs` chart, use the selectors to adjust the following settings:
35-
36-
.. list-table::
37-
:header-rows: 1
38-
:widths: 20 20 60
39-
40-
* - :strong:`Option`
41-
- :strong:`Default`
42-
- :strong:`Description`
43-
44-
* - Time
45-
- Last 8 hours
46-
- Choose the amount of time shown in the chart.
47-
48-
* - Interval
49-
- Run level
50-
- | Interval between each pair of data points.
51-
|
52-
| When you choose :strong:`Run level`, each data point on the chart corresponds to an actual run of the test; choosing larger intervals shows an aggregation of results over that time interval.
53-
|
54-
| If you choose a level higher than :strong:`Run level`, the data points you see are aggregations of multiple runs. You can select an aggregate data point in the chart to zoom in and view the data at a per-run level.
55-
56-
* - Scale
57-
- Linear
58-
- Choose whether the y-axis has a linear or logarithmic scale.
59-
60-
* - Segment by
61-
- Location
62-
- | Choose whether the data points are segmented by run location, test page, synthetic transaction, or no segmentation:
63-
|
64-
| - Choose :strong:`No segmentation` to view data points aggregated from across all locations, pages, and synthetic transactions in your test.
65-
| - Choose :strong:`Location` to compare performance across multiple test locations.
66-
| - Choose :strong:`Page` if your test includes multiple pages and you want to compare performance across pages.
67-
| - Choose :strong:`Synthetic transaction` to compare performance across multiple synthetic transactions in your test.
68-
|
69-
| Toggle between these options to see your test data sliced in various ways.
70-
71-
* - Filter
72-
- All options selected
73-
- If you have enabled segmentation, choose the run locations, pages, or transactions you want to display on the chart.
74-
75-
* - Metrics
76-
- Duration
77-
- By default, the chart displays the :guilabel:`Duration` metric. Use the drop-down list to choose the metrics you want to view in the chart.
78-
32+
See :ref:`test-kpis`.
7933

8034
View results for a specific run
8135
---------------------------------

‎synthetics/test-kpis/test-kpis.rst‎

Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
.. _test-kpis:
2+
3+
***************************************************
4+
Test performance KPIs
5+
***************************************************
6+
7+
.. meta::
8+
:description: words
9+
10+
11+
KPIs measure how well your tests are performing in a variety of circumstances. There are two tabs in this view on the test details page: availability and performance KPIs. The availability tab shows when the test was up and running versus failing, and if an auto-retry run occurred.
12+
13+
Here are some ways you can troubleshoot issues in the performance KPI chart:
14+
15+
* Zoom in on a range of time to isolate an issue.
16+
* Play or pause windows of time during troubleshooting to and open run results, screen captures, and charts in context with the selected data.
17+
* Automatically adjust data density adjusts for zoomed in views or summaries of larger time ranges.
18+
* VIew up to 90 days of historical data for related run results.
19+
20+
21+
Performance KPI chart settings
22+
--------------------------------------------------
23+
The :guilabel:`Performance KPIs` chart offers a customizable visualization of your recent test results.
24+
25+
.. list-table::
26+
:header-rows: 1
27+
:widths: 20 20 60
28+
29+
* - :strong:`Option`
30+
- :strong:`Default`
31+
- :strong:`Description`
32+
33+
* - Time
34+
- Last 8 hours
35+
- Choose the amount of time shown in the chart.
36+
37+
* - Segment by
38+
- Location
39+
- | Choose whether the data points are segmented by run location or no segmentation:
40+
|
41+
| - Choose :strong:`No segmentation` to view data points aggregated from across all locations, pages, and synthetic transactions in your test.
42+
| - Choose :strong:`Location` to compare performance across multiple test locations.
43+
|
44+
45+
* - Locations
46+
- All locations selected
47+
- Choose the run locations you want to display on the chart.
48+
49+
* - Filter
50+
- All locations selected
51+
- If you have enabled segmentation by location, choose the run locations you want to display on the chart.
52+
53+
* - Metrics
54+
- Run duration
55+
- By default, the chart displays the :guilabel:`Duration` metric. Use the drop-down list to choose the metrics you want to view in the chart.
56+

‎synthetics/uptime-test/uptime-test-results.rst‎

Lines changed: 1 addition & 48 deletions
Original file line numberDiff line numberDiff line change
@@ -33,54 +33,7 @@ On the :guilabel:`Test History` page, view a customizable summary of recent run
3333

3434
Customize the Performance KPIs chart
3535
--------------------------------------------------
36-
The :guilabel:`Performance KPIs` chart offers a customizable visualization of your recent test results. Use these steps to customize the visualization:
37-
38-
In the :guilabel:`Performance KPIs` chart, use the selectors to adjust the following settings:
39-
40-
.. list-table::
41-
:header-rows: 1
42-
:widths: 20 20 60
43-
44-
* - :strong:`Option`
45-
- :strong:`Default`
46-
- :strong:`Description`
47-
48-
* - Time
49-
- Last 8 hours
50-
- Choose the amount of time shown in the chart.
51-
52-
* - Interval
53-
- Run level
54-
- | Interval between each pair of data points.
55-
|
56-
| When you choose :strong:`Run level`, each data point on the chart corresponds to an actual run of the test; choosing larger intervals shows an aggregation of results over that time interval.
57-
|
58-
| If you choose a level higher than :strong:`Run level`, the data points you see are aggregations of multiple runs. You can select an aggregate data point in the chart to zoom in and view the data at a per-run level.
59-
60-
* - Scale
61-
- Linear
62-
- Choose whether the y-axis has a linear or logarithmic scale.
63-
64-
* - Segment by
65-
- Location
66-
- | Choose whether the data points are segmented by run location or no segmentation:
67-
|
68-
| - Choose :strong:`No segmentation` to view data points aggregated from across all locations, pages, and synthetic transactions in your test.
69-
| - Choose :strong:`Location` to compare performance across multiple test locations.
70-
|
71-
72-
* - Locations
73-
- All locations selected
74-
- Choose the run locations you want to display on the chart.
75-
76-
* - Filter
77-
- All locations selected
78-
- If you have enabled segmentation by location, choose the run locations you want to display on the chart.
79-
80-
* - Metrics
81-
- Run duration
82-
- By default, the chart displays the :guilabel:`Duration` metric. Use the drop-down list to choose the metrics you want to view in the chart.
83-
36+
See :ref:`test-kpis`.
8437

8538
View results for a specific run
8639
---------------------------------

0 commit comments

Comments
 (0)