From f9b2204514877df538444e68a7ab26e402218080 Mon Sep 17 00:00:00 2001 From: Leonard Gram Date: Tue, 1 Oct 2019 10:16:07 +0200 Subject: [PATCH] Docs: reports feature (#19472) * Docs: Reporting --- docs/sources/administration/reports.md | 40 ++++++++++++++++++++++++++ docs/sources/enterprise/_index.md | 3 ++ 2 files changed, 43 insertions(+) create mode 100644 docs/sources/administration/reports.md diff --git a/docs/sources/administration/reports.md b/docs/sources/administration/reports.md new file mode 100644 index 00000000000..02329ba754f --- /dev/null +++ b/docs/sources/administration/reports.md @@ -0,0 +1,40 @@ ++++ +title = "Reports" +description = "" +keywords = ["grafana", "reports"] +type = "docs" +[menu.docs] +parent = "admin" +weight = 8 ++++ + +# Reports + +> Reports are only available in Grafana Enterprise. Read more about [Grafana Enterprise]({{< relref "enterprise" >}}). + +> 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. + +{{< docs-imagebox img="/img/docs/enterprise/reports_list.png" max-width="500px" class="docs-image--no-shadow" >}} + +## Dashboard as a Report + +With Reports there are a few things to keep in mind, most importantly, any changes you make to the Dashboard used in a report will be reflected in the report. If you change the time range in the Dashboard the time range will be the same in the report as well. + +## Setup + +> SMTP must be configured for reports to be sent + +{{< 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. + +| Setting | Description | +| --------------|------------------------------------------------------------------ | +| Name | name of the Report | +| Dashboard | what dashboard to generate the report from | +| Recipients | emails of the people who will receive this report | +| ReplyTo | your email address, so that the recipient can respond | +| Message | message body in the email with the report | +| Schedule | how often do you want the report generated and sent | diff --git a/docs/sources/enterprise/_index.md b/docs/sources/enterprise/_index.md index 86abe4f9fdd..d627dcb5a45 100644 --- a/docs/sources/enterprise/_index.md +++ b/docs/sources/enterprise/_index.md @@ -43,6 +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" >}}). +### Reports + +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" >}}). ### Premium Plugins