IntenseWebs/grafana
3
0
Fork 0
mirror of https://github.com/grafana/grafana.git synced 2025-02-25 18:55:37 -06:00
Code Issues Packages Projects Releases Wiki Activity

Doc: Update image rendering configuration (#77042)

Browse Source 
* Doc: Update image rendering configuration

* Update docs/sources/setup-grafana/configure-grafana/_index.md

Co-authored-by: Christopher Moyer <35463610+chri2547@users.noreply.github.com>

* Update docs/sources/setup-grafana/configure-grafana/_index.md

Co-authored-by: Christopher Moyer <35463610+chri2547@users.noreply.github.com>

* Update docs/sources/setup-grafana/image-rendering/_index.md

Co-authored-by: Christopher Moyer <35463610+chri2547@users.noreply.github.com>

---------

Co-authored-by: Christopher Moyer <35463610+chri2547@users.noreply.github.com>
This commit is contained in:
Agnès Toulet
2023-11-23 15:03:13 +01:00
committed by GitHub
parent 762c7b6fe1
commit 41713353eb
3 changed files with 66 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
docs/sources/setup-grafana/configure-grafana/_index.md
View File

@@ -2302,6 +2302,14 @@ Instruct headless browser instance whether to output its debug and error message
It can be useful to set this to `true` when troubleshooting.
### rendering_timing_metrics
> **Note:** Available from grafana-image-renderer v3.9.0+
Instruct a headless browser instance on whether to record metrics for the duration of every rendering step. Default is `false`.
Setting this to `true` when optimizing the rendering mode settings to improve the plugin performance or when troubleshooting can be useful.
### rendering_args
Additional arguments to pass to the headless browser instance. Defaults are `--no-sandbox,--disable-gpu`. The list of Chromium flags can be found at (https://peter.sh/experiments/chromium-command-line-switches/). Separate multiple arguments with commas.

54
docs/sources/setup-grafana/image-rendering/_index.md
View File

@@ -229,6 +229,25 @@ ENABLE_METRICS=true
}
```
#### Enable detailed timing metrics
With the [Prometheus metrics enabled](#enable-prometheus-metrics), you can also enable detailed metrics to get the duration of every rendering step.
Default is `false`.
```bash
# Available from v3.9.0+
RENDERING_TIMING_METRICS=true
```
```json
{
"rendering": {
"timingMetrics": true
}
}
```
#### Log level
Change the log level. Default is `info` and will include log messages with level `error`, `warning` and `info`.
@@ -370,6 +389,11 @@ BROWSER_TZ=Europe/Stockholm
Instruct headless browser instance to use a default language when not provided by Grafana, e.g. when rendering panel image of alert.
Refer to the HTTP header Accept-Language to understand how to format this value.
```bash
# Available from v3.9.0+
RENDERING_LANGUAGE="fr-CH, fr;q=0.9, en;q=0.8, de;q=0.7, *;q=0.5"
```
```json
{
"rendering": {
@@ -382,6 +406,11 @@ Refer to the HTTP header Accept-Language to understand how to format this value.
Default viewport width when width is not specified in the rendering request. Default is `1000`.
```bash
# Available from v3.9.0+
RENDERING_VIEWPORT_WIDTH=1000
```
```json
{
"rendering": {
@@ -394,6 +423,11 @@ Default viewport width when width is not specified in the rendering request. Def
Default viewport height when height is not specified in the rendering request. Default is `500`.
```bash
# Available from v3.9.0+
RENDERING_VIEWPORT_HEIGHT=500
```
```json
{
"rendering": {
@@ -406,6 +440,11 @@ Default viewport height when height is not specified in the rendering request. D
Limit the maximum viewport width that can be requested. Default is `3000`.
```bash
# Available from v3.9.0+
RENDERING_VIEWPORT_MAX_WIDTH=1000
```
```json
{
"rendering": {
@@ -418,6 +457,11 @@ Limit the maximum viewport width that can be requested. Default is `3000`.
Limit the maximum viewport height that can be requested. Default is `3000`.
```bash
# Available from v3.9.0+
RENDERING_VIEWPORT_MAX_HEIGHT=500
```
```json
{
"rendering": {
@@ -431,6 +475,11 @@ Limit the maximum viewport height that can be requested. Default is `3000`.
Specify default device scale factor for rendering images. `2` is enough for monitor resolutions, `4` would be better for printed material. Setting a higher value affects performance and memory. Default is `1`.
This can be overridden in the rendering request.
```bash
# Available from v3.9.0+
RENDERING_VIEWPORT_DEVICE_SCALE_FACTOR=2
```
```json
{
"rendering": {
@@ -443,6 +492,11 @@ This can be overridden in the rendering request.
Limit the maximum device scale factor that can be requested. Default is `4`.
```bash
# Available from v3.9.0+
RENDERING_VIEWPORT_MAX_DEVICE_SCALE_FACTOR=4
```
```json
{
"rendering": {