From 7daa6605844ed9a3e2dd618f3bd8a2fc5a6e3cf3 Mon Sep 17 00:00:00 2001 From: Leonard Gram Date: Tue, 22 Oct 2019 09:38:28 +0200 Subject: [PATCH] docs: improved setup instructions for reporting (#19935) --- docs/sources/enterprise/_index.md | 4 ++-- .../reports.md => features/reporting.md} | 20 +++++++++++++------ 2 files changed, 16 insertions(+), 8 deletions(-) rename docs/sources/{administration/reports.md => features/reporting.md} (64%) diff --git a/docs/sources/enterprise/_index.md b/docs/sources/enterprise/_index.md index fb8f5d00515..4159feddeeb 100644 --- a/docs/sources/enterprise/_index.md +++ b/docs/sources/enterprise/_index.md @@ -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" >}}). -### 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 diff --git a/docs/sources/administration/reports.md b/docs/sources/features/reporting.md similarity index 64% rename from docs/sources/administration/reports.md rename to docs/sources/features/reporting.md index 02329ba754f..38f0f97e8ef 100644 --- a/docs/sources/administration/reports.md +++ b/docs/sources/features/reporting.md @@ -1,20 +1,20 @@ +++ -title = "Reports" +title = "Reporting" description = "" -keywords = ["grafana", "reports"] +keywords = ["grafana", "reporting"] type = "docs" [menu.docs] -parent = "admin" +parent = "features" 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+ -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" >}} @@ -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 +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" >}} 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 | 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 | + +## 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" >}}).