--- aliases: - ../administration/reports/ # /docs/grafana/latest/administration/reports/ - ../enterprise/export-pdf/ # /docs/grafana/latest/enterprise/export-pdf/ - ../enterprise/reporting/ # /docs/grafana/latest/enterprise/reporting/ - ../panels/create-reports/ # /docs/grafana/latest/panels/create-reports/ - reporting/ # /docs/grafana/latest/dashboards/reporting/ keywords: - grafana - reporting - export - pdf labels: products: - cloud - enterprise menuTitle: Reporting title: Create and manage reports description: Generate and share PDF reports from your Grafana dashboards weight: 600 refs: grafana-enterprise: - pattern: /docs/grafana/ destination: /docs/grafana//introduction/grafana-enterprise/ - pattern: /docs/grafana-cloud/ destination: /docs/grafana//introduction/grafana-enterprise/ image-rendering: - pattern: /docs/grafana/ destination: /docs/grafana//setup-grafana/image-rendering/ - pattern: /docs/grafana-cloud/ destination: /docs/grafana//setup-grafana/image-rendering/ max-size-configuration: - pattern: /docs/grafana/ destination: /docs/grafana//setup-grafana/configure-grafana/enterprise-configuration/#max_attachment_size_mb - pattern: /docs/grafana-cloud/ destination: /docs/grafana//setup-grafana/configure-grafana/enterprise-configuration/#max_attachment_size_mb log-filters: - pattern: /docs/grafana/ destination: /docs/grafana//setup-grafana/configure-grafana/#filters - pattern: /docs/grafana-cloud/ destination: /docs/grafana//setup-grafana/configure-grafana/#filters permission: - pattern: /docs/grafana/ destination: /docs/grafana//administration/roles-and-permissions/ - pattern: /docs/grafana-cloud/ destination: /docs/grafana//administration/roles-and-permissions/ rbac: - pattern: /docs/grafana/ destination: /docs/grafana//administration/roles-and-permissions/access-control/ - pattern: /docs/grafana-cloud/ destination: /docs/grafana//administration/roles-and-permissions/access-control/ send-report: - pattern: /docs/grafana/ destination: /docs/grafana//developers/http_api/reporting/#send-a-report - pattern: /docs/grafana-cloud/ destination: /docs/grafana-cloud/developer-resources/api-reference/http-api/reporting/#send-a-report smtp: - pattern: /docs/grafana/ destination: /docs/grafana//setup-grafana/configure-grafana/#smtp - pattern: /docs/grafana-cloud/ destination: /docs/grafana//setup-grafana/configure-grafana/#smtp temp-data-lifetime: - pattern: /docs/grafana/ destination: /docs/grafana//setup-grafana/configure-grafana/#temp_data_lifetime - pattern: /docs/grafana-cloud/ destination: /docs/grafana//setup-grafana/configure-grafana/#temp_data_lifetime templates-and-variables: - pattern: /docs/grafana/ destination: /docs/grafana//dashboards/variables/ - pattern: /docs/grafana-cloud/ destination: /docs/grafana-cloud/visualizations/dashboards/variables/ time-range-controls: - pattern: /docs/grafana/ destination: /docs/grafana//dashboards/use-dashboards/#set-dashboard-time-range - pattern: /docs/grafana-cloud/ destination: /docs/grafana-cloud/visualizations/dashboards/use-dashboards/#set-dashboard-time-range --- # Create and manage reports **Reporting** allows you to send automated and scheduled emails from any of your dashboards. You can configure several elements of these reports and generate PDFs, CSV files, and embedded images. Any changes you make to a dashboard used in a report are reflected the next time the report is sent. ## Requirements For Grafana Enterprise, the Reporting feature has the following requirements: - SMTP must be configured for reports to be sent. Refer to [SMTP configuration documentation](ref:smtp) for more information. - The [Grafana image renderer plugin](/grafana/plugins/grafana-image-renderer) (v3.10+) must be installed or the remote rendering service must be set up. Refer to [Image rendering](ref:image-rendering) for more information. ### Rendering configuration By default, attachments (PDFs, CSV files, and embedded images) larger than 10 MB are not sent, which keeps email servers from rejecting the email. You can increase or decrease this limit in the [reporting configuration](ref:max-size-configuration). When a report file is generated, it's temporarily written to the corresponding folder (`csv`, `pdf`, `png`) in the Grafana `data` folder. A background job runs every 10 minutes and removes temporary files. You can set how long a file should be stored before being removed by configuring the [`temp_data_lifetime`](ref:temp-data-lifetime) setting in your `ini` file. ## Access control Only organization administrators can create reports by default. You can customize who can create reports with [role-based access control (RBAC)](ref:rbac). When [RBAC](ref:rbac) is enabled, you need to have the relevant [permissions](ref:permission) to create and manage reports. Refer to specific guides to understand what permissions are required. ## Create a report The report creation process is multi-step, but you don't need to complete these steps in order and you can skip steps by clicking a step name at the top of the page. You can also save the report as a draft at any step in the process: ![Reporting wizard](/media/docs/grafana/dashboards/screenshot-reporting-wizard-v11.5.png) To create a report, follow these steps: 1. In the main menu, click **Dashboards > Reporting**. 1. Click **+ Create a new report**. 1. Complete the report steps, as needed: - [Select dashboard](#1-select-dashboard) - [Format report](#2-format-report) - [Schedule](#3-schedule) - [Share](#4-share) - [Confirm](#5-confirm) 1. Click one of the following buttons in the top-right corner of the screen: - **Send now** or **Schedule send** - The report is sent according the schedule you've set. - **Save as draft** - You can save a draft at any point during the report creation or update process, even if it's missing required fields. The report won't be sent according to its schedule while it's a draft. - **Discard** - Delete the report draft. This action can't be reversed. ### 1. Select dashboard At this step, select the dashboard or dashboards on which the report is based, as well as the variables and time ranges for those dashboards. The options are: | Option | Description | | ------ | ----------- | | Source dashboard (required) | Select the dashboard from which you want to generate the report. | | [Template variables](#template-variables) | Select the variable values for the selected dashboard. This option is only displayed if the dashboard has variables. | | [Time range](#time-range) | If you leave the field empty, reports use the saved time range of the dashboard. Optionally, you can change the time range of the report. | | Add another dashboard | Add more dashboards to the report. | #### Template variables This option is only displayed if the dashboard has variables. You can configure report-specific template variables for the dashboard on the report page. The variables that you select override the variables from the dashboard. For detailed information about using template variables, refer to [Variables](ref:templates-and-variables). The query variables saved with a report might become out-of-date if the results of that query change. For example, if your template variable queries for a list of hostnames and a new hostname is added, then it won't be included in the report. If that occurs, the selected variables must be manually updated in the report. If you select the **All** value for the template variable or if you keep the dashboard's original variable selection, then the report stays up-to-date as new values are added. #### Time range If you leave the **Time range** field empty, reports use the saved time range of the dashboard. Optionally, you can change the time range of the report by setting it in the **Time range** field. If specified, the custom time range overrides the time range from the report's dashboard. The page header of the report displays the time range for the dashboard's data queries. ##### Report time zones Reports use the time zone of the dashboard from which they're generated. You can control the time zone for your reports by setting the dashboard to a specific time zone. Note that this affects the display of the dashboard for all users. If a dashboard has the **Browser Time** setting, the reports generated from that dashboard use the time zone of the Grafana server. As a result, this time zone might not match the time zone of users creating or receiving the report. If you want to use a specific time zone, save the dashboard with a fixed time zone instead of **Browser Time** Each dashboard's time zone setting is visible in the [time range controls](ref:time-range-controls). ### 2. Format report At this step, select one or more report formatting options. You can select multiple options, but you must select _at least one_: - [Attach the report as a PDF](#attach-the-report-as-a-pdf) - [Include table data as PDF appendix](#table-data-in-pdf) (Public preview only) - [Embed a dashboard image in the email](#embed-a-dashboard-as-an-image-in-the-email) - [Attach a CSV file of the table panel data](#attach-a-csv-file-of-the-table-panel-data) - [Attach a separate PDF of table data](#table-data-in-pdf) (Public preview only) #### Attach the report as a PDF If you selected the PDF format option under the **Style the PDF** section, you can configure the following options: - **Configure multiple PDFs** - Click the **Combine all dashboard PDFs in one file** checkbox if you want to generate one PDF file for all the dashboards included in the report. This option is only displayed if your report includes multiple dashboards. - **Configure report header** - Click the **Show template variables** checkbox to show dashboard variables. - **Orientation** - Set the report orientation in **Portrait** or **Landscape**. Refer to the [Layout and orientation table](#layout-and-orientation) to see examples. - **Layout** - Select one of the following: - **Simple** - Renders each panel as full-width across the PDF. - **Grid** - Renders the PDF with the same panel arrangement and width as the source dashboard. Refer to the [Layout and orientation table](#layout-and-orientation) to see examples. - **Zoom** - Zoom in to enlarge text in your PDF, or zoom out to see more data (like table columns) per panel. Click **Preview PDF** in the top-right corner of the screen to view a rendered PDF with the options you selected. ##### Layout and orientation | Layout | Orientation | Description | Preview | | ------ | ----------- | --------------------------------------------------------------------------------------------------------- | ------------ | | Simple | Portrait | 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" alt="Simple layout in portrait" >}} | | Simple | Landscape | Generates an A4 page in landscape mode with a single panel per page. | {{< figure src="/static/img/docs/enterprise/reports_landscape_preview.png" max-width="500px" alt="Simple layout in landscape" >}} | | Grid | Portrait | Generates an A4 page in portrait mode with panels arranged in the same way as at the original dashboard. | {{< figure src="/static/img/docs/enterprise/reports_grid_portrait_preview.png" max-width="500px" alt="Grid layout in portrait" >}} | | Grid | Landscape | Generates an A4 page in landscape mode with panels arranged in the same way as in the original dashboard. | {{< figure src="/static/img/docs/enterprise/reports_grid_landscape_preview.png" max-width="500px" alt="Grid layout in landscape" >}} | #### Embed a dashboard as an image in the email You can send a report email with an image of the dashboard embedded in the email. This lets the email recipients see the dashboard at a glance. #### Attach a CSV file of the table panel data You can attach a CSV file to the report email for each table panel on the selected dashboard. Click **Download CSV** in the top-right corner of the screen to download a zipped file of the CSV files for your selected dashboard. #### Table data in PDF {{< admonition type="note" >}} Available in public preview (`pdfTables` feature toggle) in [Grafana Enterprise](ref:grafana-enterprise) v10.3+ with the [Grafana image renderer plugin](/grafana/plugins/grafana-image-renderer) v3.0+, as well as in [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 dashboard PDF. - **Attach a separate PDF of table data** - Generates a separate PDF file. ### 3. Schedule At this step, set scheduling information. Options vary depending on the frequency you select. | Option | Description | | ------ | ----------- | | Frequency | You can schedule reports to be sent once, or repeated on an hourly, daily, weekly, or monthly basis, or sent at custom intervals. You can also disable scheduling by selecting **Never**. For example, you might want to [send the report using the API](#send-a-report-using-the-api). | | Time | Choose one of the following:
  • **Send now** sends the report immediately after you save it. To stop sending the report at some point in the future, add an end date.
  • **Send later** schedules a report for a later date. When you select this option, the required **Start date**, **Start time**, and **Time zone** options are displayed.
| | End date | If you leave this field empty, the report is sent out indefinitely. | | Send only from Monday to Friday | For reports that have an hourly or daily frequency, you can choose to send them only from Monday to Friday. | | Send on the last day of the month | When you schedule a report with a monthly frequency, and set the start date between the 29th and the 31st of the month, the report is only sent during the months that have those dates. If you want the report to be sent every month, select the **Send on the last day of the month** option. This way, the report is sent on the last day of every month regardless of how many days there are in the month. | ### 4. Share At this step, enter information related to sharing the report: | Option | Description | | ------ | ----------- | | Report name (required) | The name of the report as you want it to appear in the **Reports** list. The report name also populates the email subject line. | | Recipients (required) | Enter the email addresses of the people or teams that you want to receive the report, separated by commas or semicolons. | | Reply-to email address | The address that appears in the **Reply to** field of the email. | | Message | The body of the message in the email with the report. | | Include a dashboard link | Include a links to the dashboards in the report email. | Click **Send test email** in the top-right corner of the screen to verify that the configuration works as expected and to verify that emails are working. You can choose to send this email to the recipients configured for the report, or to a different set of email addresses only used for testing. ### 5. Confirm At this step, the confirmation page displays all the report settings. Review them and confirm that they're correct or click the provided **Edit** links for each section to make updates. Then, click **Send now** or **Schedule send**. You can also save the report as a draft or discard it. Discarding the report is irreversible. ## Send a report using the API You can send reports programmatically with the [send report](ref:send-report) endpoint using the HTTP API. ## Manage reports On the **Reports** page, you can view and manage your existing reports or create new ones. ![Reports page](/media/docs/grafana/dashboards/screenshot-reports-page-v11.5.png) ### Edit reports To edit a report, follow these steps: 1. In the main menu, click **Dashboards > Reporting**. 1. Click the row of the report you want to update. 1. Click the **Edit report** button in the top-right hand corner or click the **Edit** link for a specific section to go to that one directly. 1. When you've finished making changes, click **Confirm** at the top of the screen to go to the last step. 1. Click **Update report**. ### Pause or resume reports {#pause-a-report} You can pause and resume sending reports from the report list view. To do this, follow these steps: 1. In the main menu, click **Dashboards > Reporting**. 1. On the row of the report you want to update, do one of the following: - Click the pause icon - The report won't be sent according to its schedule until it's resumed. - Click the resume icon - The report resumes on its previous schedule. ### Delete reports To delete a report, follow these steps: 1. In the main menu, click **Dashboards > Reporting**. 1. On the row of the report you want to update, click the trash can icon. 1. Click **Delete** to confirm. Deleting a report is irreversible. ## Troubleshoot Reporting To troubleshoot and get more log information, enable debug logging in the configuration file. Refer to the [log filters configuration documentation](ref:log-filters) for more information. ```bash [log] filters = rendering:debug,report.api:debug,report.render:debug,report.scheduler:debug,report.sender:debug,report.service:debug ```