Skip to content

Commit 4f797ab

Browse files
committed
Cloud docs: document PDF reports
1 parent ce595c9 commit 4f797ab

File tree

4 files changed

+38
-9
lines changed

4 files changed

+38
-9
lines changed

src/data/markdown/docs/03 cloud/02 Analyzing Results/09 Test Results Menu.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,9 +7,13 @@ The Test Results menu allows you to take some more actions on your specific test
77

88
![Test Results Menu](./images/08-Test-Results-Menu/test-results-menu.png)
99

10+
## Generate PDF summary
11+
12+
The PDF report is an executive summary of the test result's most relevant metrics and performance data. Read more to this [documentation](/cloud/analyzing-results/result-export#generate-pdf-report)
13+
1014
## Export data
1115

12-
Starts a data export. For more information on the structure of the export, please refer to this [documentation](/cloud/analyzing-results/result-export)
16+
Starts a data export. For more information on the structure of the export, please refer to this [documentation](/cloud/analyzing-results/result-export#export-as-csv)
1317

1418
## Share test results
1519

src/data/markdown/docs/03 cloud/02 Analyzing Results/11 Result Export.md

Lines changed: 20 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,25 @@
11
---
22
title: 'Result Export'
3-
excerpt: 'Structure for the CSV export for cloud results'
3+
excerpt: 'Exporting k6 Cloud test results. CSV format and PDF reports'
44
---
55

6-
Test result data can be exported after a test has finished and data processing complete. To do so, use the [test results menu](/cloud/analyzing-results/test-results-menu) in the top right of a test result and select `Export Data`. The data will be exported as a `.tar.gz` file with a `.csv` contained inside.
6+
Test result data can be exported after a test has finished and data processing complete in various formats:
7+
- [PDF report](#generate-pdf-report): to share the performance results with managers and executives.
8+
- [CSV format](#export-as-csv): to analyze the test result metrics deeper on your own.
79

8-
## Structure of the CSV data
10+
If you want to know other methods to analyze your test results, check out the k6 Cloud integrations with [APM tools](/cloud/integrations/apm) and the [Grafana Data Source Plugin](/cloud/integrations/grafana-plugin).
11+
12+
## Generate PDF report
13+
14+
To generate a PDF report from a test result, visit the test result, click the options menu - triple-dot button **** in the top right - and select `Generate PDF summary`. After a few seconds, the browser will prompt you to download the PDF summary report.
15+
16+
The PDF report is an executive summary of the test result's most relevant metrics and performance data. A complete PDF example can be found [here](https://f.hubspotusercontent10.net/hubfs/1681264/Executive%20Summary%20-%20Scenarios.pdf).
17+
18+
![Performance Test Result - PDF Summary Report](./images/11-Result-Export/pdf_report.png)
19+
20+
## Export as CSV
21+
22+
To export the test result as CSV, visit the test result, click the options menu - triple-dot button **** in the top right - and select `Export Data`. The data will be exported as a `.tar.gz` file with a `.csv` contained inside.
923

1024
The CSV data has the following columns of data:
1125

@@ -30,8 +44,8 @@ Here's example data, units (where necessary) and description of each field prese
3044
| `status` | 200 | number | The HTTP response status code of the request that this data point represents. |
3145
| `count` | 1.0 | number | Number of samples that this data point represents (if > 1 `response_time` is an aggregate value). |
3246
| `load_zone` | amazon:us:ashburn | string | The load zone where the request(s) was made from. |
33-
| `tags` | staticAsset=true | string | Pipe (` | `) separated list of `name=value` tags as specified for the request in the script. |
47+
| `tags` | staticAsset=true | string | Pipe separated list of `name=value` tags as specified for the request in the script. |
3448

35-
### Future
3649

37-
The exported CSV file currently only contains data from the primary HTTP response time metric (`http_req_duration`). In the future we'll expand the export feature with more HTTP data, WebSocket data, Checks data, Thresholds data as well as Custom metrics data.
50+
> **Note**
51+
> The exported CSV file currently only contains data from the primary HTTP response time metric (`http_req_duration`). In the future we'll expand the export feature with more HTTP data, WebSocket data, Checks data, Thresholds data as well as Custom metrics data.
590 KB
Loading

src/templates/docs/cloud.js

Lines changed: 13 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -181,13 +181,24 @@ export default function ({ pageContext: { sidebarTree, navLinks } }) {
181181
.
182182
</Trait>
183183
<Trait>
184-
Export results to{' '}
184+
Integrate results with{' '}
185185
<Link to={'/cloud/integrations/cloud-apm'}>
186186
APM platforms
187187
</Link>{' '}
188188
and{' '}
189+
<Link to={'/cloud/integrations/grafana-plugin'}>
190+
Grafana
191+
</Link>
192+
.
193+
</Trait>
194+
<Trait>
195+
Export results to{' '}
196+
<Link to={'/cloud/analyzing-results/result-export'}>
197+
CSV
198+
</Link>{' '}
199+
or generate{' '}
189200
<Link to={'/cloud/analyzing-results/result-export'}>
190-
CSV files
201+
PDF reports
191202
</Link>
192203
.
193204
</Trait>

0 commit comments

Comments
 (0)