mirror of
https://github.com/grafana/grafana.git
synced 2025-02-25 18:55:37 -06:00
Docs: Update docs for enterprise reporting (#37314)
* Docs: Update docs for enterprise reporting * Apply feedback * Remove old scheduler section and add screenshots * Update images links * Update reporting scheduler intro Co-authored-by: Ursula Kallio <73951760+osg-grafana@users.noreply.github.com> * Update Send now Co-authored-by: Ursula Kallio <73951760+osg-grafana@users.noreply.github.com> * Update Send later Co-authored-by: Ursula Kallio <73951760+osg-grafana@users.noreply.github.com> * Apply more feedback Co-authored-by: Ursula Kallio <73951760+osg-grafana@users.noreply.github.com> * Apply review feedback * Apply review feedback Co-authored-by: Ursula Kallio <73951760+osg-grafana@users.noreply.github.com> * Apply review feedback Co-authored-by: Ursula Kallio <73951760+osg-grafana@users.noreply.github.com> * Apply more feedback Co-authored-by: Ursula Kallio <73951760+osg-grafana@users.noreply.github.com> Co-authored-by: Ursula Kallio <73951760+osg-grafana@users.noreply.github.com>
This commit is contained in:
Tania B
GitHub
@@ -13,7 +13,7 @@ Reporting allows you to automatically generate PDFs from any of your dashboards
|
||||
> If you have [Fine-grained access Control]({{< relref "../enterprise/access-control/_index.md" >}}) enabled, for some actions you would need to have relevant permissions.
|
||||
Refer to specific guides to understand what permissions are required.
|
||||
|
||||
{{< figure src="/static/img/docs/enterprise/reports_list.png" max-width="500px" class="docs-image--no-shadow" >}}
|
||||
{{< figure src="/static/img/docs/enterprise/reports_list_8.1.png" max-width="500px" class="docs-image--no-shadow" >}}
|
||||
|
||||
Any changes you make to a dashboard used in a report are reflected the next time the report is sent. For example, if you change the time range in the dashboard, then the time range in the report changes as well.
|
||||
|
||||
@@ -47,7 +47,7 @@ Only organization admins can create reports by default. You can customize who ca
|
||||
1. **Save** the report.
|
||||
1. **Send test email** to verify that the whole configuration is working as expected. 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.
|
||||
|
||||
{{< figure src="/static/img/docs/enterprise/reports-create-new-8.0.png" max-width="500px" class="docs-image--no-shadow" >}}
|
||||
{{< figure src="/static/img/docs/enterprise/reports_create_new_8.1.png" max-width="500px" class="docs-image--no-shadow" >}}
|
||||
|
||||
### Choose template variables
|
||||
|
||||
@@ -106,48 +106,26 @@ 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]({{< relref "../administration/configuration/#temp-data-lifetime" >}}) setting. This setting also affects how long a renderer PNG file should be stored.
|
||||
|
||||
### Scheduling
|
||||
> Note: Scheduler has been significantly changed in Grafana Enterprise v8.1.
|
||||
|
||||
Scheduled reports can be sent on a monthly, weekly, daily, or hourly basis. You may also disable scheduling for when you either want to send it via the API.
|
||||
Scheduled reports can be sent once or repeatedly on an hourly, daily, weekly, or monthly basis, or at custom intervals. You can also disable scheduling by selecting **Never**: for example, if you want to send the report via the API.
|
||||
|
||||
All scheduling indicates when the reporting service will start rendering the dashboard. It can take a few minutes to render a dashboard with a lot of panels.
|
||||
{{< figure src="/static/img/docs/enterprise/reports_scheduler_8.1.png" max-width="500px" class="docs-image--no-shadow" >}}
|
||||
|
||||
#### Hourly
|
||||
|
||||
Hourly reports are generated once per hour. All fields are required.
|
||||
**Send now or schedule for later**
|
||||
|
||||
- **At minute -** The number of minutes after full hour when the report should be generated.
|
||||
- **Time zone -** Time zone to determine the offset of the full hour. Does not currently change the time in the rendered report.
|
||||
- **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. If you leave the end date empty, the report is sent out indefinitely.
|
||||
|
||||
#### Daily
|
||||
- **Send later** schedules a report for a later date. Thus, the start date and time are required fields. If you leave the end date empty, the report is sent out indefinitely.
|
||||
|
||||
Daily reports are generated once per day. All fields are required.
|
||||
**Send only from Monday to Friday**
|
||||
|
||||
- **Time -** Time the report is sent, in 24-hour format.
|
||||
- **Time zone -** Time zone for the **Time** field.
|
||||
For reports that have an hourly or daily frequency, you can choose to send them only from Monday to Friday.
|
||||
|
||||
#### Weekly
|
||||
**Send on the last day of the month**
|
||||
|
||||
Weekly reports are generated once per week. All fields are required.
|
||||
|
||||
- **Day -** Weekday which the report should be sent on.
|
||||
- **Time -** Time the report is sent, in 24-hour format.
|
||||
- **Time zone -** Time zone for the **Time** field.
|
||||
|
||||
#### Monthly
|
||||
|
||||
> Only available in Grafana Enterprise v7.1+.
|
||||
|
||||
Monthly reports are generated once per month. All fields are required.
|
||||
|
||||
- **Day in month -** Day of the month when the report should be sent. You can select `last` for reports that should go out on the last day of the month.
|
||||
- **Time -** Time the report is sent, in 24-hour format.
|
||||
- **Time zone -** Time zone for the **Time** field.
|
||||
|
||||
#### Never
|
||||
|
||||
> Only available in Grafana Enterprise v7.0+.
|
||||
|
||||
Reports which are scheduled to never be sent have no parameter and will not be sent to the scheduler. They may be manually generated from the **Send test email** prompt or via the [Reporting API]({{< relref "../http_api/reporting.md" >}}).
|
||||
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 instead. This way, the report is sent on the last day of every month regardless of how many days there are in any given month.
|
||||
|
||||
### Send test email
|
||||
|
||||
|
||||
Reference in New Issue
Block a user