grafana-image-renderer: init at 2020-12-01

This package[1] is a replacement for the old phantomjs-integration[2]
which is practically EOL. It is basically used to render PNGs of panels
that triggered an alert in Grafana.

This package internally uses `puppeteer`[3] to control a headless
Chromium instance. Even though puppeteer recommends to use a fixed
revision of `chromium`, I checked that our default `pkgs.chromium` works
fine as well. Also, I don't think it's a good idea to use outdated
browser versions[4].

I used the latest revision from `master` on purpose since compiling the
code with `tsc` from `v2.0` didn't work and I couldn't figure out why.

[1] https://grafana.com/grafana/plugins/grafana-image-renderer
[2] https://grafana.com/blog/2020/05/07/grafana-7.0-preview-new-image-renderer-plugin-to-replace-phantomjs/
[3] https://github.com/puppeteer/puppeteer
[4] currently, puppeteer v2.0.0 is used which recommends revision 706915
    (v79.0.3945.130).
This commit is contained in:
Maximilian Bosch 2020-12-23 17:36:05 +01:00
parent ae48d62bb8
commit a9d0682475
No known key found for this signature in database
GPG Key ID: 091DBF4D1FC46B8E
5 changed files with 6704 additions and 0 deletions

View File

@ -0,0 +1,67 @@
{ lib, mkYarnPackage, fetchFromGitHub, nodejs, runtimeShell }:
# Notes for the upgrade:
# * Download the tarball of the new version to use.
# * Remove the `resolutions`-section from upstream `package.json`
# as this breaks with `yarn2nix`.
# * Regenerate `yarn.lock` and `yarn2nix`.
# * Replace new `package.json`, `yarn.nix`, `yarn.lock` here.
# * Update `version`+`hash` and rebuild.
mkYarnPackage rec {
name = "grafana-image-renderer-unstable";
version = "2020-12-01";
src = fetchFromGitHub {
owner = "grafana";
repo = "grafana-image-renderer";
rev = "ce1f81438e5f69c7fd7c73ce08bab624c4c92e25";
sha256 = "sha256-1Ke1KLLNZ1dkLH0BWB60r2c45RBbndd0eepjc0nlHVk=";
};
buildPhase = ''
runHook preBuild
pushd deps/renderer
npm run build
popd
runHook postBuild
'';
dontInstall = true;
packageJSON = ./package.json;
yarnNix = ./yarn.nix;
yarnLock = ./yarn.lock;
distPhase = ''
runHook preDist
shopt -s extglob
pushd deps/renderer
install_path="$out/libexec/grafana-image-renderer"
mkdir -p $install_path
cp -R ../../node_modules $install_path
cp -R ./!(node_modules) $install_path
popd
mkdir -p $out/bin
cat >$out/bin/grafana-image-renderer <<EOF
#! ${runtimeShell}
${nodejs}/bin/node $install_path/build/app.js \$@
EOF
chmod +x $out/bin/grafana-image-renderer
runHook postDist
'';
meta = with lib; {
homepage = "https://github.com/grafana/grafana-image-renderer";
description = "A Grafana backend plugin that handles rendering of panels & dashboards to PNGs using headless browser (Chromium/Chrome)";
license = licenses.asl20;
maintainers = with maintainers; [ ma27 ];
platforms = platforms.linux;
};
}

View File

@ -0,0 +1,69 @@
{
"name": "renderer",
"version": "1.0.0",
"author": "Grafana Labs",
"license": "Apache-2.0",
"repository": {
"type": "git",
"url": "http://github.com/grafana/grafana-image-renderer.git"
},
"scripts": {
"tslint": "tslint -c tslint.json --project tsconfig.json",
"typecheck": "tsc --noEmit",
"prettier:check": "prettier --list-different \"**/*.ts\"",
"prettier:write": "prettier --list-different \"**/*.ts\" --write",
"precommit": "npm run tslint & npm run typecheck",
"watch": "tsc-watch --onSuccess \"node build/app.js server --config=dev.json\"",
"build": "tsc",
"start": "node build/app.js --config=dev.json"
},
"dependencies": {
"@grpc/grpc-js": "^1.0",
"@grpc/proto-loader": "^0.5.4",
"@hapi/boom": "^9.1.0",
"express": "^4.16.3",
"express-prom-bundle": "^5.1.5",
"google-protobuf": "3.5.0",
"lodash": "^4.17.19",
"minimist": "^1.2.0",
"morgan": "^1.9.0",
"mz": "^2.7.0",
"prom-client": "^11.5.3",
"puppeteer": "^2.0.0",
"puppeteer-cluster": "^0.18.0",
"unique-filename": "^1.1.0",
"winston": "^3.2.1"
},
"devDependencies": {
"@types/express": "^4.11.1",
"@types/node": "^10.0.9",
"husky": "^3.1.0",
"lint-staged": "^9.5.0",
"pkg": "4.4.8",
"prettier": "^1.19.1",
"tsc-watch": "^4.2.3",
"tslint": "^6.1.1",
"typescript": "^3.8.3"
},
"husky": {
"hooks": {
"pre-commit": "lint-staged && npm run precommit"
}
},
"lint-staged": {
"*.ts": [
"prettier --write",
"git add"
]
},
"pkg": {
"assets": "proto/*"
},
"bin": "build/app.js",
"engines": {
"node": ">=12 <13"
},
"volta": {
"node": "12.19.0"
}
}

File diff suppressed because it is too large Load Diff

File diff suppressed because it is too large Load Diff

View File

@ -17108,6 +17108,8 @@ in
grafana_reporter = callPackage ../servers/monitoring/grafana-reporter { };
grafana-image-renderer = callPackage ../servers/monitoring/grafana-image-renderer { };
gerbera = callPackage ../servers/gerbera {};
gobetween = callPackage ../servers/gobetween { };