Docs: Add table data in PDF (#80059)

* Docs: Add table data in PDF

* fix lint issues

* Switch to public preview

* Apply suggestions from code review

Co-authored-by: Isabel <76437239+imatwawana@users.noreply.github.com>

---------

Co-authored-by: Isabel <76437239+imatwawana@users.noreply.github.com>
This commit is contained in:
Agnès Toulet 2024-01-05 15:57:13 +01:00 committed by GitHub
parent f5a221e93f
commit 41eff02d75
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
4 changed files with 16 additions and 4 deletions

View File

@ -116,8 +116,6 @@ If the time zone is set differently between your Grafana server and its remote i
### Layout and orientation
> We're actively developing new report layout options. [Contact us](https://grafana.com/contact?about=grafana-enterprise&topic=design-process&value=reporting) to get involved in the design process.
| Layout | Orientation | Support | Description | Preview |
| ------ | ----------- | ------- | --------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Simple | Portrait | v6.4+ | Generates an A4 page in portrait mode with three panels per page. | {{< figure src="/static/img/docs/enterprise/reports_portrait_preview.png" max-width="500px" max-height="500px" class="docs-image--no-shadow" alt="Simple layout in portrait" >}} |
@ -137,6 +135,19 @@ When the CSV file is generated, it is temporarily written to the `csv` folder in
A background job runs every 10 minutes and removes temporary CSV files. You can configure how long a CSV file should be stored before being removed by configuring the [temp-data-lifetime][] setting. This setting also affects how long a renderer PNG file should be stored.
### Table data in PDF
{{% admonition type="note" %}}
Available in public preview (`pdfTables` feature toggle) in [Grafana Enterprise][] v10.3+ with the [Grafana image renderer plugin](/grafana/plugins/grafana-image-renderer) v3.0+, and [Grafana Cloud](/docs/grafana-cloud/).
{{% /admonition %}}
When there's more data in your table visualizations than can be shown in the dashboard PDF, you can select one of these two options to access all table visualization data as PDF in your reports:
- **Include table data as PDF appendix** - Adds an appendix to the main dashboard PDF.
- **Attach a separate PDF of table data** - Generates a separate PDF file.
This feature relies on the same plugin that supports the [image rendering][] features.
### Scheduling
> **Note:** Available in [Grafana Enterprise][] version 8.0 and later, and [Grafana Cloud](/docs/grafana-cloud/).

View File

@ -80,6 +80,7 @@ Some features are enabled by default. You can disable these feature by setting t
| `reportingRetries` | Enables rendering retries for the reporting feature |
| `transformationsVariableSupport` | Allows using variables in transformations |
| `cloudWatchBatchQueries` | Runs CloudWatch metrics queries as separate batches |
| `pdfTables` | Enables generating table data as PDF in reporting |
## Experimental feature toggles

View File

@ -1164,7 +1164,7 @@ var (
{
Name: "pdfTables",
Description: "Enables generating table data as PDF in reporting",
Stage: FeatureStagePrivatePreview,
Stage: FeatureStagePublicPreview,
FrontendOnly: false,
Owner: grafanaSharingSquad,
Created: time.Date(2023, time.November, 6, 12, 0, 0, 0, time.UTC),

View File

@ -137,7 +137,7 @@ extractFieldsNameDeduplication,experimental,@grafana/grafana-bi-squad,2023-11-02
dashboardSceneForViewers,experimental,@grafana/dashboards-squad,2023-11-02,false,false,false,true
dashboardScene,experimental,@grafana/dashboards-squad,2023-11-13,false,false,false,true
panelFilterVariable,experimental,@grafana/dashboards-squad,2023-11-03,false,false,false,true
pdfTables,privatePreview,@grafana/sharing-squad,2023-11-06,false,false,false,false
pdfTables,preview,@grafana/sharing-squad,2023-11-06,false,false,false,false
ssoSettingsApi,experimental,@grafana/identity-access-team,2023-11-08,true,false,false,false
canvasPanelPanZoom,experimental,@grafana/dataviz-squad,2023-12-27,false,false,false,true
logsInfiniteScrolling,experimental,@grafana/observability-logs,2023-11-09,false,false,false,true

1 Name Stage Owner Created requiresDevMode RequiresLicense RequiresRestart FrontendOnly
137 dashboardSceneForViewers experimental @grafana/dashboards-squad 2023-11-02 false false false true
138 dashboardScene experimental @grafana/dashboards-squad 2023-11-13 false false false true
139 panelFilterVariable experimental @grafana/dashboards-squad 2023-11-03 false false false true
140 pdfTables privatePreview preview @grafana/sharing-squad 2023-11-06 false false false false
141 ssoSettingsApi experimental @grafana/identity-access-team 2023-11-08 true false false false
142 canvasPanelPanZoom experimental @grafana/dataviz-squad 2023-12-27 false false false true
143 logsInfiniteScrolling experimental @grafana/observability-logs 2023-11-09 false false false true