Backend image rendering as plugin (#11966)

* rendering: headless chrome progress

* renderer: minor change

* grpc: version hell

* updated grpc libs

* wip: minor progess

* rendering: new image rendering plugin is starting to work

* feat: now phantomjs works as well and updated alerting to use new rendering service

* refactor: renamed renderer package and service to rendering to make renderer name less confusing (rendering is internal service that handles the renderer plugin now)

* rendering: now render key is passed and render auth is working in plugin mode

* removed unneeded lines from gitignore

* rendering: now plugin mode supports waiting for all panels to complete rendering

* fix: LastSeenAt fix for render calls, was not set which causes a lot of updates to Last Seen at during rendering, this should fix sqlite db locked issues in seen in previous releases

* change: changed render tz url parameter to use proper timezone name as chrome does not handle UTC offset TZ values

* fix: another update to tz param generation

* renderer: added http mode to renderer service, new ini setting [rendering] server_url

pkg/plugins/backend_utils.go

@@ -0,0 +1,19 @@
+package plugins
+
+import (
+	"fmt"
+	"runtime"
+	"strings"
+)
+
+func ComposePluginStartCommmand(executable string) string {
+	os := strings.ToLower(runtime.GOOS)
+	arch := runtime.GOARCH
+	extension := ""
+
+	if os == "windows" {
+		extension = ".exe"
+	}
+
+	return fmt.Sprintf("%s_%s_%s%s", executable, os, strings.ToLower(arch), extension)
+}

pkg/plugins/datasource/wrapper/datasource_plugin_wrapper.go

@@ -5,12 +5,12 @@ import (
 	"errors"
 	"fmt"
 
+	"github.com/grafana/grafana-plugin-model/go/datasource"
 	"github.com/grafana/grafana/pkg/components/null"
 	"github.com/grafana/grafana/pkg/components/simplejson"
 	"github.com/grafana/grafana/pkg/log"
 	"github.com/grafana/grafana/pkg/models"
 	"github.com/grafana/grafana/pkg/tsdb"
-	"github.com/grafana/grafana_plugin_model/go/datasource"
 )
 
 func NewDatasourcePluginWrapper(log log.Logger, plugin datasource.DatasourcePlugin) *DatasourcePluginWrapper {

pkg/plugins/datasource/wrapper/datasource_plugin_wrapper_test.go

@@ -3,9 +3,9 @@ package wrapper
 import (
 	"testing"
 
+	"github.com/grafana/grafana-plugin-model/go/datasource"
 	"github.com/grafana/grafana/pkg/log"
 	"github.com/grafana/grafana/pkg/tsdb"
-	"github.com/grafana/grafana_plugin_model/go/datasource"
 )
 
 func TestMapTables(t *testing.T) {

pkg/plugins/datasource_plugin.go

@@ -3,20 +3,17 @@ package plugins
 import (
 	"context"
 	"encoding/json"
-	"fmt"
 	"os"
 	"os/exec"
 	"path"
 	"path/filepath"
-	"runtime"
-	"strings"
 	"time"
 
+	"github.com/grafana/grafana-plugin-model/go/datasource"
 	"github.com/grafana/grafana/pkg/log"
 	"github.com/grafana/grafana/pkg/models"
 	"github.com/grafana/grafana/pkg/plugins/datasource/wrapper"
 	"github.com/grafana/grafana/pkg/tsdb"
-	"github.com/grafana/grafana_plugin_model/go/datasource"
 	plugin "github.com/hashicorp/go-plugin"
 )
 
@@ -66,16 +63,6 @@ var handshakeConfig = plugin.HandshakeConfig{
 	MagicCookieValue: "datasource",
 }
 
-func composeBinaryName(executable, os, arch string) string {
-	var extension string
-	os = strings.ToLower(os)
-	if os == "windows" {
-		extension = ".exe"
-	}
-
-	return fmt.Sprintf("%s_%s_%s%s", executable, os, strings.ToLower(arch), extension)
-}
-
 func (p *DataSourcePlugin) startBackendPlugin(ctx context.Context, log log.Logger) error {
 	p.log = log.New("plugin-id", p.Id)
 
@@ -88,7 +75,7 @@ func (p *DataSourcePlugin) startBackendPlugin(ctx context.Context, log log.Logge
 }
 
 func (p *DataSourcePlugin) spawnSubProcess() error {
-	cmd := composeBinaryName(p.Executable, runtime.GOOS, runtime.GOARCH)
+	cmd := ComposePluginStartCommmand(p.Executable)
 	fullpath := path.Join(p.PluginDir, cmd)
 
 	p.client = plugin.NewClient(&plugin.ClientConfig{

pkg/plugins/datasource_plugin_test.go

@@ -1,35 +0,0 @@
-package plugins
-
-import (
-	"testing"
-)
-
-func TestComposeBinaryName(t *testing.T) {
-	tests := []struct {
-		name string
-		os   string
-		arch string
-
-		expectedPath string
-	}{
-		{
-			name:         "simple-json",
-			os:           "linux",
-			arch:         "amd64",
-			expectedPath: `simple-json_linux_amd64`,
-		},
-		{
-			name:         "simple-json",
-			os:           "windows",
-			arch:         "amd64",
-			expectedPath: `simple-json_windows_amd64.exe`,
-		},
-	}
-
-	for _, v := range tests {
-		have := composeBinaryName(v.name, v.os, v.arch)
-		if have != v.expectedPath {
-			t.Errorf("expected %s got %s", v.expectedPath, have)
-		}
-	}
-}

pkg/plugins/plugins.go

@@ -26,6 +26,7 @@ var (
 	Apps         map[string]*AppPlugin
 	Plugins      map[string]*PluginBase
 	PluginTypes  map[string]interface{}
+	Renderer     *RendererPlugin
 
 	GrafanaLatestVersion string
 	GrafanaHasUpdate     bool
@@ -58,6 +59,7 @@ func (pm *PluginManager) Init() error {
 		"panel":      PanelPlugin{},
 		"datasource": DataSourcePlugin{},
 		"app":        AppPlugin{},
+		"renderer":   RendererPlugin{},
 	}
 
 	pm.log.Info("Starting plugin search")

pkg/plugins/renderer_plugin.go

@@ -0,0 +1,22 @@
+package plugins
+
+import "encoding/json"
+
+type RendererPlugin struct {
+	PluginBase
+
+	Executable string `json:"executable,omitempty"`
+}
+
+func (r *RendererPlugin) Load(decoder *json.Decoder, pluginDir string) error {
+	if err := decoder.Decode(&r); err != nil {
+		return err
+	}
+
+	if err := r.registerPlugin(pluginDir); err != nil {
+		return err
+	}
+
+	Renderer = r
+	return nil
+}