[v11.5] Remove relref shortcodes (#101707)
* manually replce all shared relrefs * relref replace - grafana v11.5 * Merge branch 'master' into robbymilo/relref-replace-grafana-11.5 * manual fixes * replace ref shortcodes * Merge branch 'master' into robbymilo/relref-replace-grafana-11.5 * update readme * update test --------- Co-authored-by: Jack Baldry <jack.baldry@grafana.com>
This commit is contained in:
Robby Milo
co-authored by
Jack Baldry
Jack Baldry
parent
fe4442a7fb
commit
96d15d9091
@@ -18,17 +18,17 @@ weight: 1000
|
||||
|
||||
# Set up image rendering
|
||||
|
||||
Grafana supports automatic rendering of panels as PNG images. This allows Grafana to automatically generate images of your panels to include in alert notifications, [PDF export]({{< relref "../../dashboards/create-reports#export-dashboard-as-pdf" >}}), and [Reporting]({{< relref "../../dashboards/create-reports" >}}). PDF Export and Reporting are available only in [Grafana Enterprise]({{< relref "../../introduction/grafana-enterprise" >}}) and [Grafana Cloud](/docs/grafana-cloud/).
|
||||
Grafana supports automatic rendering of panels as PNG images. This allows Grafana to automatically generate images of your panels to include in alert notifications, [PDF export](../../dashboards/create-reports/#export-dashboard-as-pdf), and [Reporting](../../dashboards/create-reports/). PDF Export and Reporting are available only in [Grafana Enterprise](../../introduction/grafana-enterprise/) and [Grafana Cloud](/docs/grafana-cloud/).
|
||||
|
||||
While an image is being rendered, the PNG image is temporarily written to the file system. When the image is rendered, the PNG image is temporarily written to the `png` folder in the Grafana `data` folder.
|
||||
|
||||
A background job runs every 10 minutes and removes temporary images. You can configure how long an image should be stored before being removed by configuring the [temp_data_lifetime]({{< relref "../configure-grafana#temp_data_lifetime" >}}) setting.
|
||||
A background job runs every 10 minutes and removes temporary images. You can configure how long an image should be stored before being removed by configuring the [temp_data_lifetime](../configure-grafana/#temp_data_lifetime) setting.
|
||||
|
||||
You can also render a PNG by hovering over the panel to display the actions menu in the top-right corner, and then clicking **Share > Share link**. The **Render image** option is displayed in the link settings.
|
||||
|
||||
## Alerting and render limits
|
||||
|
||||
Alert notifications can include images, but rendering many images at the same time can overload the server where the renderer is running. For instructions of how to configure this, see [max_concurrent_screenshots]({{< relref "../configure-grafana#max_concurrent_screenshots" >}}).
|
||||
Alert notifications can include images, but rendering many images at the same time can overload the server where the renderer is running. For instructions of how to configure this, see [max_concurrent_screenshots](../configure-grafana/#max_concurrent_screenshots).
|
||||
|
||||
## Install Grafana Image Renderer plugin
|
||||
|
||||
@@ -48,7 +48,7 @@ Rendering multiple images in parallel requires an even bigger memory footprint.
|
||||
|
||||
The Grafana Image Renderer plugin has a number of configuration options that are used in plugin or remote rendering modes.
|
||||
|
||||
In plugin mode, you can specify them directly in the [Grafana configuration file]({{< relref "../configure-grafana#plugingrafana-image-renderer" >}}).
|
||||
In plugin mode, you can specify them directly in the [Grafana configuration file](../configure-grafana/#plugingrafana-image-renderer).
|
||||
|
||||
In remote rendering mode, you can specify them in a `.json` [configuration file](#configuration-file) or, for some of them, you can override the configuration defaults using environment variables.
|
||||
|
||||
@@ -94,7 +94,7 @@ AUTH_TOKEN=-
|
||||
}
|
||||
```
|
||||
|
||||
See [Grafana configuration]({{< relref "../configure-grafana#renderer_token" >}}) for how to configure the token in Grafana.
|
||||
See [Grafana configuration](../configure-grafana/#renderer_token) for how to configure the token in Grafana.
|
||||
|
||||
### Rendering mode
|
||||
|
||||
@@ -164,7 +164,7 @@ RENDERING_MODE=reusable
|
||||
|
||||
#### Optimize the performance, CPU and memory usage of the image renderer
|
||||
|
||||
The performance and resources consumption of the different modes depend a lot on the number of concurrent requests your service is handling. To understand how many concurrent requests your service is handling, [monitor your image renderer service]({{< relref "./monitoring" >}}).
|
||||
The performance and resources consumption of the different modes depend a lot on the number of concurrent requests your service is handling. To understand how many concurrent requests your service is handling, [monitor your image renderer service](monitoring/).
|
||||
|
||||
With no concurrent requests, the different modes show very similar performance and CPU / memory usage.
|
||||
|
||||
@@ -256,7 +256,7 @@ Minimum TLS version allowed. Accepted values are: `TLSv1.2`, `TLSv1.3`. Default
|
||||
|
||||
#### Enable Prometheus metrics
|
||||
|
||||
You can enable [Prometheus](https://prometheus.io/) metrics endpoint `/metrics` using the environment variable `ENABLE_METRICS`. Node.js and render request duration metrics are included, see [Enable Prometheus metrics endpoint]({{< relref "./monitoring#enable-prometheus-metrics-endpoint" >}}) for details.
|
||||
You can enable [Prometheus](https://prometheus.io/) metrics endpoint `/metrics` using the environment variable `ENABLE_METRICS`. Node.js and render request duration metrics are included, see [Enable Prometheus metrics endpoint](monitoring/#enable-prometheus-metrics-endpoint) for details.
|
||||
|
||||
Default is `false`.
|
||||
|
||||
|
||||
@@ -18,7 +18,7 @@ weight: 100
|
||||
|
||||
# Monitor the image renderer
|
||||
|
||||
Rendering images requires a lot of memory, mainly because Grafana creates browser instances in the background for the actual rendering. Monitoring your service can help you allocate the right amount of resources to your rendering service and set the right [rendering mode]({{< relref "../../image-rendering#rendering-mode" >}}).
|
||||
Rendering images requires a lot of memory, mainly because Grafana creates browser instances in the background for the actual rendering. Monitoring your service can help you allocate the right amount of resources to your rendering service and set the right [rendering mode](../#rendering-mode).
|
||||
|
||||
## Enable Prometheus metrics endpoint
|
||||
|
||||
|
||||
@@ -32,7 +32,7 @@ You can enable debug log messages for rendering in the Grafana configuration fil
|
||||
filters = rendering:debug
|
||||
```
|
||||
|
||||
You can also enable more logs in image renderer service itself by enabling [debug logging]({{< relref "#enable-debug-logging" >}}).
|
||||
You can also enable more logs in image renderer service itself by enabling [debug logging](#enable-debug-logging).
|
||||
|
||||
## Missing libraries
|
||||
|
||||
|
||||
Reference in New Issue
Block a user