871ad73414
grafana-plugin-model is legacy and is replaced by new backend plugins SDK and architecture. Renderer is not part of SDK and we want to keep it that way for now since it's highly unlikely there will be more than one kind of renderer plugin. So this PR adds support for renderer plugin v2. Also adds support sending a Device Scale Factor parameter to the plugin v2 remote rendering service and by that replaces #22474. Adds support sending a Headers parameter to the plugin v2 and remote rendering service which for now only include Accect-Language header (the user locale in browser when using Grafana), ref grafana/grafana-image-renderer#45. Fixes health check json details response. Adds image renderer plugin configuration settings in defaults.ini and sample.ini. Co-Authored-By: Arve Knudsen <arve.knudsen@gmail.com>
96 lines
2.6 KiB
Go
96 lines
2.6 KiB
Go
package rendering
|
|
|
|
import (
|
|
"context"
|
|
"fmt"
|
|
"time"
|
|
|
|
pluginModel "github.com/grafana/grafana-plugin-model/go/renderer"
|
|
"github.com/grafana/grafana/pkg/plugins/backendplugin/pluginextensionv2"
|
|
)
|
|
|
|
func (rs *RenderingService) startPlugin(ctx context.Context) error {
|
|
return rs.pluginInfo.Start(ctx)
|
|
}
|
|
|
|
func (rs *RenderingService) renderViaPlugin(ctx context.Context, renderKey string, opts Opts) (*RenderResult, error) {
|
|
// gives plugin some additional time to timeout and return possible errors.
|
|
ctx, cancel := context.WithTimeout(ctx, opts.Timeout+time.Second*2)
|
|
defer cancel()
|
|
|
|
if rs.pluginInfo.GrpcPluginV2 != nil {
|
|
return rs.renderViaPluginV2(ctx, renderKey, opts)
|
|
}
|
|
|
|
return rs.renderViaPluginV1(ctx, renderKey, opts)
|
|
}
|
|
|
|
func (rs *RenderingService) renderViaPluginV1(ctx context.Context, renderKey string, opts Opts) (*RenderResult, error) {
|
|
pngPath, err := rs.getFilePathForNewImage()
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
|
|
req := &pluginModel.RenderRequest{
|
|
Url: rs.getURL(opts.Path),
|
|
Width: int32(opts.Width),
|
|
Height: int32(opts.Height),
|
|
FilePath: pngPath,
|
|
Timeout: int32(opts.Timeout.Seconds()),
|
|
RenderKey: renderKey,
|
|
Encoding: opts.Encoding,
|
|
Timezone: isoTimeOffsetToPosixTz(opts.Timezone),
|
|
Domain: rs.domain,
|
|
}
|
|
rs.log.Debug("calling renderer plugin", "req", req)
|
|
|
|
rsp, err := rs.pluginInfo.GrpcPluginV1.Render(ctx, req)
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
if rsp.Error != "" {
|
|
return nil, fmt.Errorf("rendering failed: %v", rsp.Error)
|
|
}
|
|
|
|
return &RenderResult{FilePath: pngPath}, nil
|
|
}
|
|
|
|
func (rs *RenderingService) renderViaPluginV2(ctx context.Context, renderKey string, opts Opts) (*RenderResult, error) {
|
|
pngPath, err := rs.getFilePathForNewImage()
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
|
|
headers := map[string]*pluginextensionv2.StringList{}
|
|
|
|
for k, values := range opts.Headers {
|
|
headers[k] = &pluginextensionv2.StringList{
|
|
Values: values,
|
|
}
|
|
}
|
|
|
|
req := &pluginextensionv2.RenderRequest{
|
|
Url: rs.getURL(opts.Path),
|
|
Width: int32(opts.Width),
|
|
Height: int32(opts.Height),
|
|
DeviceScaleFactor: float32(opts.DeviceScaleFactor),
|
|
FilePath: pngPath,
|
|
Timeout: int32(opts.Timeout.Seconds()),
|
|
RenderKey: renderKey,
|
|
Timezone: isoTimeOffsetToPosixTz(opts.Timezone),
|
|
Domain: rs.domain,
|
|
Headers: headers,
|
|
}
|
|
rs.log.Debug("Calling renderer plugin", "req", req)
|
|
|
|
rsp, err := rs.pluginInfo.GrpcPluginV2.Render(ctx, req)
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
if rsp.Error != "" {
|
|
return nil, fmt.Errorf("Rendering failed: %v", rsp.Error)
|
|
}
|
|
|
|
return &RenderResult{FilePath: pngPath}, err
|
|
}
|