mirror of
https://github.com/grafana/grafana.git
synced 2024-12-02 13:39:19 -06:00
5c0fbbf7c8
* improve remote image rendering - determine "domain" during Init() so we are not re-parsing settings on every request - if using http-mode via a rednererUrl, then use the AppUrl for the page that the renderer loads. When in http-mode the renderer is likely running on another server so trying to use the localhost or even the specific IP:PORT grafana is listening on wont work. - apply the request timeout via a context rather then directly on the http client. - use a global http client so we can take advantage of connection re-use - log and handle errors better. * ensure imagesDir exists * allow users to define callback_url for remote rendering - allow users to define the url that a remote rendering service should use for connecting back to the grafana instance. By default the "root_url" is used. * improve remote image rendering - determine "domain" during Init() so we are not re-parsing settings on every request - if using http-mode via a rednererUrl, then use the AppUrl for the page that the renderer loads. When in http-mode the renderer is likely running on another server so trying to use the localhost or even the specific IP:PORT grafana is listening on wont work. - apply the request timeout via a context rather then directly on the http client. - use a global http client so we can take advantage of connection re-use - log and handle errors better. * ensure imagesDir exists * allow users to define callback_url for remote rendering - allow users to define the url that a remote rendering service should use for connecting back to the grafana instance. By default the "root_url" is used. * rendering: fixed issue with renderKey where userId and orgId was in mixed up, added test for RenderCallbackUrl reading logic
122 lines
3.0 KiB
Go
122 lines
3.0 KiB
Go
package rendering
|
|
|
|
import (
|
|
"context"
|
|
"fmt"
|
|
"net/url"
|
|
"os"
|
|
"path/filepath"
|
|
|
|
plugin "github.com/hashicorp/go-plugin"
|
|
|
|
pluginModel "github.com/grafana/grafana-plugin-model/go/renderer"
|
|
"github.com/grafana/grafana/pkg/log"
|
|
"github.com/grafana/grafana/pkg/middleware"
|
|
"github.com/grafana/grafana/pkg/models"
|
|
"github.com/grafana/grafana/pkg/plugins"
|
|
"github.com/grafana/grafana/pkg/registry"
|
|
"github.com/grafana/grafana/pkg/setting"
|
|
"github.com/grafana/grafana/pkg/util"
|
|
)
|
|
|
|
func init() {
|
|
registry.RegisterService(&RenderingService{})
|
|
}
|
|
|
|
type RenderingService struct {
|
|
log log.Logger
|
|
pluginClient *plugin.Client
|
|
grpcPlugin pluginModel.RendererPlugin
|
|
pluginInfo *plugins.RendererPlugin
|
|
renderAction renderFunc
|
|
domain string
|
|
|
|
Cfg *setting.Cfg `inject:""`
|
|
}
|
|
|
|
func (rs *RenderingService) Init() error {
|
|
rs.log = log.New("rendering")
|
|
|
|
// ensure ImagesDir exists
|
|
err := os.MkdirAll(rs.Cfg.ImagesDir, 0700)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
|
|
// set value used for domain attribute of renderKey cookie
|
|
if rs.Cfg.RendererUrl != "" {
|
|
// RendererCallbackUrl has already been passed, it wont generate an error.
|
|
u, _ := url.Parse(rs.Cfg.RendererCallbackUrl)
|
|
rs.domain = u.Hostname()
|
|
} else if setting.HttpAddr != setting.DEFAULT_HTTP_ADDR {
|
|
rs.domain = setting.HttpAddr
|
|
} else {
|
|
rs.domain = "localhost"
|
|
}
|
|
|
|
return nil
|
|
}
|
|
|
|
func (rs *RenderingService) Run(ctx context.Context) error {
|
|
if rs.Cfg.RendererUrl != "" {
|
|
rs.log.Info("Backend rendering via external http server")
|
|
rs.renderAction = rs.renderViaHttp
|
|
<-ctx.Done()
|
|
return nil
|
|
}
|
|
|
|
if plugins.Renderer == nil {
|
|
rs.renderAction = rs.renderViaPhantomJS
|
|
<-ctx.Done()
|
|
return nil
|
|
}
|
|
|
|
rs.pluginInfo = plugins.Renderer
|
|
|
|
if err := rs.startPlugin(ctx); err != nil {
|
|
return err
|
|
}
|
|
|
|
rs.renderAction = rs.renderViaPlugin
|
|
|
|
err := rs.watchAndRestartPlugin(ctx)
|
|
|
|
if rs.pluginClient != nil {
|
|
rs.log.Debug("Killing renderer plugin process")
|
|
rs.pluginClient.Kill()
|
|
}
|
|
|
|
return err
|
|
}
|
|
|
|
func (rs *RenderingService) Render(ctx context.Context, opts Opts) (*RenderResult, error) {
|
|
if rs.renderAction != nil {
|
|
return rs.renderAction(ctx, opts)
|
|
} else {
|
|
return nil, fmt.Errorf("No renderer found")
|
|
}
|
|
}
|
|
|
|
func (rs *RenderingService) getFilePathForNewImage() string {
|
|
pngPath, _ := filepath.Abs(filepath.Join(rs.Cfg.ImagesDir, util.GetRandomString(20)))
|
|
return pngPath + ".png"
|
|
}
|
|
|
|
func (rs *RenderingService) getURL(path string) string {
|
|
if rs.Cfg.RendererUrl != "" {
|
|
// The backend rendering service can potentially be remote.
|
|
// So we need to use the root_url to ensure the rendering service
|
|
// can reach this Grafana instance.
|
|
|
|
// &render=1 signals to the legacy redirect layer to
|
|
return fmt.Sprintf("%s%s&render=1", rs.Cfg.RendererCallbackUrl, path)
|
|
|
|
}
|
|
// &render=1 signals to the legacy redirect layer to
|
|
return fmt.Sprintf("%s://%s:%s/%s&render=1", setting.Protocol, rs.domain, setting.HttpPort, path)
|
|
}
|
|
|
|
func (rs *RenderingService) getRenderKey(orgId, userId int64, orgRole models.RoleType) string {
|
|
return middleware.AddRenderAuthKey(orgId, userId, orgRole)
|
|
}
|