Cloud docs: document PDF reports

grafana · Mar 25, 2021 · 4f797ab · 4f797ab
1 parent ce595c9
commit 4f797ab
Show file tree

Hide file tree

Showing 4 changed files with 38 additions and 9 deletions.
diff --git a/src/data/markdown/docs/03 cloud/02 Analyzing Results/09 Test Results Menu.md b/src/data/markdown/docs/03 cloud/02 Analyzing Results/09 Test Results Menu.md
@@ -7,9 +7,13 @@ The Test Results menu allows you to take some more actions on your specific test
 
 ![Test Results Menu](./images/08-Test-Results-Menu/test-results-menu.png)
 
+## Generate PDF summary
+
+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)
+
 ## Export data
 
-Starts a data export. For more information on the structure of the export, please refer to this [documentation](/cloud/analyzing-results/result-export)
+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)
 
 ## Share test results
 

diff --git a/src/data/markdown/docs/03 cloud/02 Analyzing Results/11 Result Export.md b/src/data/markdown/docs/03 cloud/02 Analyzing Results/11 Result Export.md
@@ -1,11 +1,25 @@
 ---
 title: 'Result Export'
-excerpt: 'Structure for the CSV export for cloud results'
+excerpt: 'Exporting k6 Cloud test results. CSV format and PDF reports'
 ---
 
-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.
+Test result data can be exported after a test has finished and data processing complete in various formats:
+- [PDF report](#generate-pdf-report): to share the performance results with managers and executives.
+- [CSV format](#export-as-csv): to analyze the test result metrics deeper on your own.
 
-## Structure of the CSV data
+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).
+
+## Generate PDF report
+
+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.
+
+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).
+
+![Performance Test Result - PDF Summary Report](./images/11-Result-Export/pdf_report.png)
+
+## Export as CSV
+
+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.
 
 The CSV data has the following columns of data:
 
@@ -30,8 +44,8 @@ Here's example data, units (where necessary) and description of each field prese
 | `status`        | 200                              | number         | The HTTP response status code of the request that this data point represents.                                                             |
 | `count`         | 1.0                              | number         | Number of samples that this data point represents (if > 1 `response_time` is an aggregate value).                                         |
 | `load_zone`     | amazon:us:ashburn                | string         | The load zone where the request(s) was made from.                                                                                         |
-| `tags`          | staticAsset=true                 | string         | Pipe (`                                                                                                                                   | `) separated list of `name=value` tags as specified for the request in the script. |
+| `tags`          | staticAsset=true                 | string         | Pipe separated list of `name=value` tags as specified for the request in the script. |
 
-### Future
 
-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.
+> **Note**
+> 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.
diff --git a/...kdown/docs/03 cloud/02 Analyzing Results/images/11-Result-Export/pdf_report.png b/...kdown/docs/03 cloud/02 Analyzing Results/images/11-Result-Export/pdf_report.png
diff --git a/src/templates/docs/cloud.js b/src/templates/docs/cloud.js
@@ -181,13 +181,24 @@ export default function ({ pageContext: { sidebarTree, navLinks } }) {
                       .
                     </Trait>
                     <Trait>
-                      Export results to{' '}
+                      Integrate results with{' '}
                       <Link to={'/cloud/integrations/cloud-apm'}>
                         APM platforms
                       </Link>{' '}
                       and{' '}
+                      <Link to={'/cloud/integrations/grafana-plugin'}>
+                        Grafana
+                      </Link>
+                      .
+                    </Trait>
+                    <Trait>
+                      Export results to{' '}
+                      <Link to={'/cloud/analyzing-results/result-export'}>
+                        CSV
+                      </Link>{' '}
+                      or generate{' '}
                       <Link to={'/cloud/analyzing-results/result-export'}>
-                        CSV files
+                        PDF reports
                       </Link>
                       .
                     </Trait>