Skip to content

Commit db62179

Browse files
authored
Release v1.0.12 (#125)
1 parent 9b3949a commit db62179

File tree

4 files changed

+32
-10
lines changed

4 files changed

+32
-10
lines changed

CHANGELOG.md

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,11 @@
1+
## 1.0.12 (2020-03-31)
2+
3+
- Remote rendering: Delete temporary file after serving it to client [#120](https://github.com/grafana/grafana-image-renderer/pull/120), [marefr](https://github.com/marefr)
4+
- Remote rendering: More configuration options [#123](https://github.com/grafana/grafana-image-renderer/pull/123), [marefr](https://github.com/marefr)
5+
16
## 1.0.12-beta1 (2020-03-30)
27

3-
- More configuration options to ease investigation [#123](https://github.com/grafana/grafana-image-renderer/pull/123), [marefr](https://github.com/marefr)
8+
- Remote rendering: More configuration options [#123](https://github.com/grafana/grafana-image-renderer/pull/123), [marefr](https://github.com/marefr)
49

510
## 1.0.11 (2020-03-20)
611

README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
A Grafana backend plugin that handles rendering panels and dashboards to PNGs using headless Chrome.
1+
A Grafana backend plugin that handles rendering panels and dashboards to PNGs using a headless browser (Chromium).
22

33
## Requirements
44

@@ -44,15 +44,15 @@ You can override certain settings by using environment variables and making sure
4444

4545
**Default timezone:**
4646

47-
Instruct headless Chrome to use a default timezone when not provided by Grafana, e.g. when rendering panel image of alert. See [ICU’s metaZones.txt](https://cs.chromium.org/chromium/src/third_party/icu/source/data/misc/metaZones.txt?rcl=faee8bc70570192d82d2978a71e2a615788597d1) for a list of supported timezone IDs. Fallbacks to `TZ` environment variable if not set.
47+
Instruct headless browser instance to use a default timezone when not provided by Grafana, e.g. when rendering panel image of alert. See [ICU’s metaZones.txt](https://cs.chromium.org/chromium/src/third_party/icu/source/data/misc/metaZones.txt?rcl=faee8bc70570192d82d2978a71e2a615788597d1) for a list of supported timezone IDs. Fallbacks to `TZ` environment variable if not set.
4848

4949
```bash
5050
GF_RENDERER_PLUGIN_TZ=Europe/Stockholm
5151
```
5252

5353
**Ignore HTTPS errors:**
5454

55-
Instruct headless Chrome whether to ignore HTTPS errors during navigation. Per default HTTPS errors is not ignored.
55+
Instruct headless browser instance whether to ignore HTTPS errors during navigation. Per default HTTPS errors is not ignored.
5656
Due to the security risk it's not recommended to ignore HTTPS errors.
5757

5858
```bash
@@ -69,7 +69,7 @@ GF_RENDERER_PLUGIN_GRPC_PORT=50059
6969

7070
**Verbose logging:**
7171

72-
Instruct headless Chrome whether to capture and log verbose information when rendering an image. Default is `false` and will only capture and log error messages. When enabled, `true`, debug messages are captured and logged as well.
72+
Instruct headless browser instance whether to capture and log verbose information when rendering an image. Default is `false` and will only capture and log error messages. When enabled, `true`, debug messages are captured and logged as well.
7373

7474
For the verbose information to be included in the Grafana server log you have to adjust the rendering log level to `debug`, see [Troubleshoot image rendering](https://grafana.com/docs/grafana/latest/administration/image_rendering/#troubleshoot-image-rendering) for instructions.
7575

docs/remote_rendering_using_docker.md

Lines changed: 20 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -26,15 +26,15 @@ HTTP_PORT=0
2626

2727
**Default timezone:**
2828

29-
Instruct headless Chrome to use a default timezone when not provided by Grafana, .e.g. when rendering panel image of alert. See [ICU’s metaZones.txt](https://cs.chromium.org/chromium/src/third_party/icu/source/data/misc/metaZones.txt?rcl=faee8bc70570192d82d2978a71e2a615788597d1) for a list of supported timezone IDs. Fallbacks to `TZ` environment variable if not set.
29+
Instruct headless browser instance to use a default timezone when not provided by Grafana, .e.g. when rendering panel image of alert. See [ICU’s metaZones.txt](https://cs.chromium.org/chromium/src/third_party/icu/source/data/misc/metaZones.txt?rcl=faee8bc70570192d82d2978a71e2a615788597d1) for a list of supported timezone IDs. Fallbacks to `TZ` environment variable if not set.
3030

3131
```bash
3232
BROWSER_TZ=Europe/Stockholm
3333
```
3434

3535
**Ignore HTTPS errors:**
3636

37-
Instruct headless Chrome whether to ignore HTTPS errors during navigation. Per default HTTPS errors is not ignored.
37+
Instruct headless browser instance whether to ignore HTTPS errors during navigation. Per default HTTPS errors is not ignored.
3838
Due to the security risk it's not recommended to ignore HTTPS errors.
3939

4040
```bash
@@ -59,14 +59,31 @@ LOG_LEVEL=debug
5959

6060
**Verbose logging:**
6161

62-
Instruct headless Chrome whether to capture and log verbose information when rendering an image. Default is `false` and will only capture and log error messages. When enabled (`true`) debug messages are captured and logged as well.
62+
Instruct headless browser instance whether to capture and log verbose information when rendering an image. Default is `false` and will only capture and log error messages. When enabled (`true`) debug messages are captured and logged as well.
6363

6464
Note that you need to change log level to `debug`, see above, for the verbose information to be included in the logs.
6565

6666
```bash
6767
RENDERING_VERBOSE_LOGGING=true
6868
```
6969

70+
**Capture browser output:**
71+
72+
Instruct headless browser instance whether to output its debug and error messages into running process of remote rendering service. Default is `false`.
73+
This can be useful to enable (`true`) when troubleshooting.
74+
75+
```bash
76+
RENDERING_DUMPIO=true
77+
```
78+
79+
**Start browser with additional arguments:**
80+
81+
Additional arguments to pass to the headless browser instance. Default is `--no-sandbox`. The list of Chromium flags can be found [here](https://peter.sh/experiments/chromium-command-line-switches/). Multiple arguments is separated with comma-character.
82+
83+
```bash
84+
RENDERING_ARGS=--no-sandbox,--disable-setuid-sandbox,--disable-dev-shm-usage,--disable-accelerated-2d-canvas,--disable-gpu,--window-size=1280x758
85+
```
86+
7087
## Configuration file
7188

7289
You can override certain settings by using a configuration file, see [default.json](https://github.com/grafana/grafana-image-renderer/tree/master/default.json) for defaults. Note that any configured environment variable takes precedence over configuration file settings.

plugin.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,8 +18,8 @@
1818
{"name": "Project site", "url": "https://github.com/grafana/grafana-image-renderer"},
1919
{"name": "Apache License", "url": "https://github.com/grafana/grafana-image-renderer/blob/master/LICENSE"}
2020
],
21-
"version": "1.0.12-beta1",
22-
"updated": "2020-03-30",
21+
"version": "1.0.12",
22+
"updated": "2020-03-31",
2323
"dependencies": {
2424
"grafanaVersion": "5.2"
2525
}

0 commit comments

Comments
 (0)