Commit 7daa6605 by Leonard Gram Committed by GitHub

docs: improved setup instructions for reporting (#19935)

parent 2a8762f6
...@@ -43,9 +43,9 @@ Supported auth providers: ...@@ -43,9 +43,9 @@ Supported auth providers:
Data source permissions allow you to restrict query access to only specific Teams and Users. [Learn More]({{< relref "permissions/datasource_permissions.md" >}}). Data source permissions allow you to restrict query access to only specific Teams and Users. [Learn More]({{< relref "permissions/datasource_permissions.md" >}}).
### Reports ### Reporting
Reports make it possible to take any Dashboard and generate a PDF report and setup a schedule to have it delivered. [Learn More]({{< relref "administration/reports.md" >}}). Reporting make it possible to take any Dashboard and generate a PDF report and setup a schedule to have it delivered. [Learn More]({{< relref "features/reporting.md" >}}).
### Premium Plugins ### Premium Plugins
......
+++ +++
title = "Reports" title = "Reporting"
description = "" description = ""
keywords = ["grafana", "reports"] keywords = ["grafana", "reporting"]
type = "docs" type = "docs"
[menu.docs] [menu.docs]
parent = "admin" parent = "features"
weight = 8 weight = 8
+++ +++
# Reports # Reporting
> Reports are only available in Grafana Enterprise. Read more about [Grafana Enterprise]({{< relref "enterprise" >}}). > Reporting is only available in Grafana Enterprise. Read more about [Grafana Enterprise]({{< relref "enterprise" >}}).
> Only available in Grafana v6.4+ > Only available in Grafana v6.4+
With Reports you can generate PDFs of any of your Dashboards and have them sent out to interested parties on a schedule. Reporting allows you to generate PDFs from any of your Dashboards and have them sent out to interested parties on a schedule.
{{< docs-imagebox img="/img/docs/enterprise/reports_list.png" max-width="500px" class="docs-image--no-shadow" >}} {{< docs-imagebox img="/img/docs/enterprise/reports_list.png" max-width="500px" class="docs-image--no-shadow" >}}
...@@ -26,6 +26,10 @@ With Reports there are a few things to keep in mind, most importantly, any chang ...@@ -26,6 +26,10 @@ With Reports there are a few things to keep in mind, most importantly, any chang
> SMTP must be configured for reports to be sent > SMTP must be configured for reports to be sent
We recommend using the new image rendering plugin with reporting as it supports a wider range of panels than the built-in image rendering. Read more about it [here]({{< relref "administration/image_rendering.md#grafana-image-renderer-plugin" >}})
## Usage
{{< docs-imagebox img="/img/docs/enterprise/reports_create_new.png" max-width="500px" class="docs-image--no-shadow" >}} {{< docs-imagebox img="/img/docs/enterprise/reports_create_new.png" max-width="500px" class="docs-image--no-shadow" >}}
Currently only Organisation Admins can create reports. To get to report click on the reports icon in the side menu. This will allow you to list, create and update your reports. Currently only Organisation Admins can create reports. To get to report click on the reports icon in the side menu. This will allow you to list, create and update your reports.
...@@ -38,3 +42,7 @@ Currently only Organisation Admins can create reports. To get to report click on ...@@ -38,3 +42,7 @@ Currently only Organisation Admins can create reports. To get to report click on
| ReplyTo | your email address, so that the recipient can respond | | ReplyTo | your email address, so that the recipient can respond |
| Message | message body in the email with the report | | Message | message body in the email with the report |
| Schedule | how often do you want the report generated and sent | | Schedule | how often do you want the report generated and sent |
## Debugging errors
If you have problems with the reporting feature you can enable debug logging by switching the logger to debug (`filters = report:debug`). Learn more about making configuration changes [here]({{< relref "installation/configuration.md#filters" >}}).
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment