Skip to content

Commit 004e269

Browse files
Merge pull request #247401 from yegu-ms/image-rendering
Added more information on image rendering in alerts
2 parents ab96621 + 2a4d05d commit 004e269

File tree

1 file changed

+9
-4
lines changed

1 file changed

+9
-4
lines changed

articles/managed-grafana/how-to-use-reporting-and-image-rendering.md

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -19,10 +19,15 @@ Generating reports in the PDF format requires Grafana's image rendering capabili
1919

2020
## Image rendering performance
2121

22-
Image rendering is a CPU-intensive operation. An Azure Managed Grafana instance needs about 10 seconds to render one panel, assuming data query is completed in less than 1 second. The Grafana software only allows a maximum of 200 seconds to generate an entire report. Dashboards should contain no more than 20 panels each if they're used in PDF reports. You may have to reduce the panel number further if you plan to include other artifacts (for example, CSV) in the reports.
22+
Image rendering is a CPU-intensive operation. An Azure Managed Grafana instance needs about 10 seconds to render one panel, assuming data query is completed in less than 1 second. The Grafana software allows a maximum of 200 seconds to generate an entire report. Dashboards should contain no more than 20 panels each if they're used in PDF reports. You may have to reduce the panel number further if you plan to include other artifacts (for example, CSV) in the reports.
2323

2424
> [!NOTE]
25-
> You'll see a "504 Gateway Timeout" error if a rendering request has exceeded the 200 second limit.
25+
> You'll see a "Image Rendering Timeout" error if a rendering request has exceeded the 200 second limit.
26+
27+
For screen-capturing in alerts, the Grafana software only allows 30 seconds to snapshot panel images before timing out. At most three screenshots can be taken within this time frame. If there's a sudden surge in alert volume, some alerts may not have screenshots even if screen-capturing has been enabled.
28+
29+
> [!NOTE]
30+
> Overloading the Grafana image renderer may cause it to become unstable. You can reduce the number of alerts that must include screenshots by only setting the Dashboard UID and Panel ID annotations in those alert rules.
2631

2732
## Prerequisites
2833

@@ -54,9 +59,9 @@ To create a new report, follow these steps.
5459
4. Choose a layout option in the PDF tab.
5560
5. Select **Save as PDF** to export.
5661

57-
## Use images in notifications
62+
## Use image in alerts
5863

59-
Grafana allows screen-capturing a panel that triggers an alert. Recipients can see the panel image directly in the notification message. Azure Managed Grafana is currently configured to upload these screenshots to the local storage on your instance. Only the list of contact points in the **Upload from disk** column of the [Supported contact points](https://grafana.com/docs/grafana/latest/alerting/manage-notifications/images-in-notifications/#supported-contact-points) table can receive the images. In addition, there's a 30-second time limit for taking a screenshot. If a screenshot can't be completed in time, it isn't included with the corresponding alert.
64+
Grafana allows screen-capturing a panel that triggers an alert. Recipients can see the panel image directly in the notification message. Azure Managed Grafana is currently configured to upload these screenshots to the local storage on your instance. Only the list of contact points in the **Upload from disk** column of the [Supported contact points](https://grafana.com/docs/grafana/latest/alerting/manage-notifications/images-in-notifications/#supported-contact-points) table can receive the images. In addition, there's a 30-second time limit for taking a screenshot. If a screenshot can't be completed in time, it isn't included with the corresponding alert. Screenshots are taken only for those alerts that have Dashboard UID and Panel ID annotations in the rule. You can use these annotations to disable screen-capturing selectively.
6065

6166
## Next steps
6267

0 commit comments

Comments
 (0)