mirror of https://github.com/grafana/grafana
live: add ws endpoint to push into pipeline (#41534)
Alexander Emelin
4 years ago
committed by
GitHub
parent
f3f441f4ec
commit
1700b2c2f3
@ -1,200 +0,0 @@ |
||||
package pushws |
||||
|
||||
import ( |
||||
"fmt" |
||||
"net/http" |
||||
"net/url" |
||||
"strings" |
||||
"time" |
||||
|
||||
"github.com/grafana/grafana/pkg/infra/log" |
||||
"github.com/grafana/grafana/pkg/services/live/convert" |
||||
"github.com/grafana/grafana/pkg/services/live/livecontext" |
||||
"github.com/grafana/grafana/pkg/services/live/managedstream" |
||||
"github.com/grafana/grafana/pkg/services/live/pushurl" |
||||
|
||||
"github.com/gorilla/websocket" |
||||
liveDto "github.com/grafana/grafana-plugin-sdk-go/live" |
||||
) |
||||
|
||||
var ( |
||||
logger = log.New("live.push_ws") |
||||
) |
||||
|
||||
// Handler handles WebSocket client connections that push data to Live.
|
||||
type Handler struct { |
||||
managedStreamRunner *managedstream.Runner |
||||
config Config |
||||
upgrade *websocket.Upgrader |
||||
converter *convert.Converter |
||||
} |
||||
|
||||
// Config represents config for Handler.
|
||||
type Config struct { |
||||
// ReadBufferSize is a parameter that is used for raw websocket Upgrader.
|
||||
// If set to zero reasonable default value will be used.
|
||||
ReadBufferSize int |
||||
|
||||
// WriteBufferSize is a parameter that is used for raw websocket Upgrader.
|
||||
// If set to zero reasonable default value will be used.
|
||||
WriteBufferSize int |
||||
|
||||
// MessageSizeLimit sets the maximum size in bytes of allowed message from client.
|
||||
// By default DefaultWebsocketMessageSizeLimit will be used.
|
||||
MessageSizeLimit int |
||||
|
||||
// CheckOrigin func to provide custom origin check logic,
|
||||
// zero value means same host check.
|
||||
CheckOrigin func(r *http.Request) bool |
||||
|
||||
// PingInterval sets interval server will send ping messages to clients.
|
||||
// By default DefaultWebsocketPingInterval will be used.
|
||||
PingInterval time.Duration |
||||
} |
||||
|
||||
// NewHandler creates new Handler.
|
||||
func NewHandler(managedStreamRunner *managedstream.Runner, c Config) *Handler { |
||||
if c.CheckOrigin == nil { |
||||
c.CheckOrigin = sameHostOriginCheck() |
||||
} |
||||
upgrade := &websocket.Upgrader{ |
||||
ReadBufferSize: c.ReadBufferSize, |
||||
WriteBufferSize: c.WriteBufferSize, |
||||
CheckOrigin: c.CheckOrigin, |
||||
} |
||||
return &Handler{ |
||||
managedStreamRunner: managedStreamRunner, |
||||
config: c, |
||||
upgrade: upgrade, |
||||
converter: convert.NewConverter(), |
||||
} |
||||
} |
||||
|
||||
func sameHostOriginCheck() func(r *http.Request) bool { |
||||
return func(r *http.Request) bool { |
||||
err := checkSameHost(r) |
||||
if err != nil { |
||||
logger.Warn("Origin check failure", "origin", r.Header.Get("origin"), "error", err) |
||||
return false |
||||
} |
||||
return true |
||||
} |
||||
} |
||||
|
||||
func checkSameHost(r *http.Request) error { |
||||
origin := r.Header.Get("Origin") |
||||
if origin == "" { |
||||
return nil |
||||
} |
||||
u, err := url.Parse(origin) |
||||
if err != nil { |
||||
return fmt.Errorf("failed to parse Origin header %q: %w", origin, err) |
||||
} |
||||
if strings.EqualFold(r.Host, u.Host) { |
||||
return nil |
||||
} |
||||
return fmt.Errorf("request Origin %q is not authorized for Host %q", origin, r.Host) |
||||
} |
||||
|
||||
// Defaults.
|
||||
const ( |
||||
DefaultWebsocketPingInterval = 25 * time.Second |
||||
DefaultWebsocketMessageSizeLimit = 1024 * 1024 // 1MB
|
||||
) |
||||
|
||||
func (s *Handler) ServeHTTP(rw http.ResponseWriter, r *http.Request) { |
||||
streamID, ok := livecontext.GetContextStreamID(r.Context()) |
||||
if !ok || streamID == "" { |
||||
logger.Warn("Push request without stream ID") |
||||
rw.WriteHeader(http.StatusInternalServerError) |
||||
return |
||||
} |
||||
|
||||
conn, err := s.upgrade.Upgrade(rw, r, nil) |
||||
if err != nil { |
||||
return |
||||
} |
||||
|
||||
pingInterval := s.config.PingInterval |
||||
if pingInterval == 0 { |
||||
pingInterval = DefaultWebsocketPingInterval |
||||
} |
||||
messageSizeLimit := s.config.MessageSizeLimit |
||||
if messageSizeLimit == 0 { |
||||
messageSizeLimit = DefaultWebsocketMessageSizeLimit |
||||
} |
||||
|
||||
if messageSizeLimit > 0 { |
||||
conn.SetReadLimit(int64(messageSizeLimit)) |
||||
} |
||||
if pingInterval > 0 { |
||||
pongWait := pingInterval * 10 / 9 |
||||
_ = conn.SetReadDeadline(time.Now().Add(pongWait)) |
||||
conn.SetPongHandler(func(string) error { |
||||
_ = conn.SetReadDeadline(time.Now().Add(pongWait)) |
||||
return nil |
||||
}) |
||||
} |
||||
|
||||
go func() { |
||||
ticker := time.NewTicker(25 * time.Second) |
||||
defer ticker.Stop() |
||||
for { |
||||
select { |
||||
case <-r.Context().Done(): |
||||
return |
||||
case <-ticker.C: |
||||
deadline := time.Now().Add(pingInterval / 2) |
||||
err := conn.WriteControl(websocket.PingMessage, nil, deadline) |
||||
if err != nil { |
||||
return |
||||
} |
||||
} |
||||
} |
||||
}() |
||||
|
||||
user, ok := livecontext.GetContextSignedUser(r.Context()) |
||||
if !ok { |
||||
logger.Error("No user found in context") |
||||
rw.WriteHeader(http.StatusInternalServerError) |
||||
return |
||||
} |
||||
|
||||
for { |
||||
_, body, err := conn.ReadMessage() |
||||
if err != nil { |
||||
break |
||||
} |
||||
|
||||
stream, err := s.managedStreamRunner.GetOrCreateStream(user.OrgId, liveDto.ScopeStream, streamID) |
||||
if err != nil { |
||||
logger.Error("Error getting stream", "error", err) |
||||
continue |
||||
} |
||||
|
||||
// TODO Grafana 8: decide which formats to use or keep all.
|
||||
urlValues := r.URL.Query() |
||||
frameFormat := pushurl.FrameFormatFromValues(urlValues) |
||||
|
||||
logger.Debug("Live Push request", |
||||
"protocol", "http", |
||||
"streamId", streamID, |
||||
"bodyLength", len(body), |
||||
"frameFormat", frameFormat, |
||||
) |
||||
|
||||
metricFrames, err := s.converter.Convert(body, frameFormat) |
||||
if err != nil { |
||||
logger.Error("Error converting metrics", "error", err, "frameFormat", frameFormat) |
||||
continue |
||||
} |
||||
|
||||
for _, mf := range metricFrames { |
||||
err := stream.Push(mf.Key(), mf.Frame()) |
||||
if err != nil { |
||||
logger.Error("Error pushing frame", "error", err, "data", string(body)) |
||||
return |
||||
} |
||||
} |
||||
} |
||||
} |
||||
@ -0,0 +1,82 @@ |
||||
package pushws |
||||
|
||||
import ( |
||||
"net/http" |
||||
|
||||
"github.com/grafana/grafana/pkg/services/live/convert" |
||||
"github.com/grafana/grafana/pkg/services/live/livecontext" |
||||
"github.com/grafana/grafana/pkg/services/live/pipeline" |
||||
|
||||
"github.com/gorilla/websocket" |
||||
) |
||||
|
||||
// PipelinePushHandler handles WebSocket client connections that push data to Live Pipeline.
|
||||
type PipelinePushHandler struct { |
||||
pipeline *pipeline.Pipeline |
||||
config Config |
||||
upgrade *websocket.Upgrader |
||||
converter *convert.Converter |
||||
} |
||||
|
||||
// NewPathHandler creates new PipelinePushHandler.
|
||||
func NewPipelinePushHandler(pipeline *pipeline.Pipeline, c Config) *PipelinePushHandler { |
||||
if c.CheckOrigin == nil { |
||||
c.CheckOrigin = sameHostOriginCheck() |
||||
} |
||||
upgrade := &websocket.Upgrader{ |
||||
ReadBufferSize: c.ReadBufferSize, |
||||
WriteBufferSize: c.WriteBufferSize, |
||||
CheckOrigin: c.CheckOrigin, |
||||
} |
||||
return &PipelinePushHandler{ |
||||
pipeline: pipeline, |
||||
config: c, |
||||
upgrade: upgrade, |
||||
converter: convert.NewConverter(), |
||||
} |
||||
} |
||||
|
||||
func (s *PipelinePushHandler) ServeHTTP(rw http.ResponseWriter, r *http.Request) { |
||||
channelID, ok := livecontext.GetContextChannelID(r.Context()) |
||||
if !ok || channelID == "" { |
||||
logger.Warn("Push request without channel") |
||||
rw.WriteHeader(http.StatusInternalServerError) |
||||
return |
||||
} |
||||
|
||||
user, ok := livecontext.GetContextSignedUser(r.Context()) |
||||
if !ok { |
||||
logger.Error("No user found in context") |
||||
rw.WriteHeader(http.StatusInternalServerError) |
||||
return |
||||
} |
||||
|
||||
conn, err := s.upgrade.Upgrade(rw, r, nil) |
||||
if err != nil { |
||||
return |
||||
} |
||||
setupWSConn(r.Context(), conn, s.config) |
||||
|
||||
for { |
||||
_, body, err := conn.ReadMessage() |
||||
if err != nil { |
||||
break |
||||
} |
||||
|
||||
logger.Debug("Live channel push request", |
||||
"protocol", "http", |
||||
"channel", channelID, |
||||
"bodyLength", len(body), |
||||
) |
||||
|
||||
ruleFound, err := s.pipeline.ProcessInput(r.Context(), user.OrgId, channelID, body) |
||||
if err != nil { |
||||
logger.Error("Pipeline input processing error", "error", err, "body", string(body)) |
||||
return |
||||
} |
||||
if !ruleFound { |
||||
logger.Error("No conversion rule for a channel", "error", err, "channel", channelID) |
||||
return |
||||
} |
||||
} |
||||
} |
||||
@ -0,0 +1,99 @@ |
||||
package pushws |
||||
|
||||
import ( |
||||
"net/http" |
||||
|
||||
"github.com/grafana/grafana/pkg/services/live/convert" |
||||
"github.com/grafana/grafana/pkg/services/live/livecontext" |
||||
"github.com/grafana/grafana/pkg/services/live/managedstream" |
||||
"github.com/grafana/grafana/pkg/services/live/pushurl" |
||||
|
||||
"github.com/gorilla/websocket" |
||||
liveDto "github.com/grafana/grafana-plugin-sdk-go/live" |
||||
) |
||||
|
||||
// Handler handles WebSocket client connections that push data to Live.
|
||||
type Handler struct { |
||||
managedStreamRunner *managedstream.Runner |
||||
config Config |
||||
upgrade *websocket.Upgrader |
||||
converter *convert.Converter |
||||
} |
||||
|
||||
// NewHandler creates new Handler.
|
||||
func NewHandler(managedStreamRunner *managedstream.Runner, c Config) *Handler { |
||||
if c.CheckOrigin == nil { |
||||
c.CheckOrigin = sameHostOriginCheck() |
||||
} |
||||
upgrade := &websocket.Upgrader{ |
||||
ReadBufferSize: c.ReadBufferSize, |
||||
WriteBufferSize: c.WriteBufferSize, |
||||
CheckOrigin: c.CheckOrigin, |
||||
} |
||||
return &Handler{ |
||||
managedStreamRunner: managedStreamRunner, |
||||
config: c, |
||||
upgrade: upgrade, |
||||
converter: convert.NewConverter(), |
||||
} |
||||
} |
||||
|
||||
func (s *Handler) ServeHTTP(rw http.ResponseWriter, r *http.Request) { |
||||
streamID, ok := livecontext.GetContextStreamID(r.Context()) |
||||
if !ok || streamID == "" { |
||||
logger.Warn("Push request without stream ID") |
||||
rw.WriteHeader(http.StatusInternalServerError) |
||||
return |
||||
} |
||||
|
||||
user, ok := livecontext.GetContextSignedUser(r.Context()) |
||||
if !ok { |
||||
logger.Error("No user found in context") |
||||
rw.WriteHeader(http.StatusInternalServerError) |
||||
return |
||||
} |
||||
|
||||
conn, err := s.upgrade.Upgrade(rw, r, nil) |
||||
if err != nil { |
||||
return |
||||
} |
||||
setupWSConn(r.Context(), conn, s.config) |
||||
|
||||
for { |
||||
_, body, err := conn.ReadMessage() |
||||
if err != nil { |
||||
break |
||||
} |
||||
|
||||
stream, err := s.managedStreamRunner.GetOrCreateStream(user.OrgId, liveDto.ScopeStream, streamID) |
||||
if err != nil { |
||||
logger.Error("Error getting stream", "error", err) |
||||
continue |
||||
} |
||||
|
||||
// TODO Grafana 8: decide which formats to use or keep all.
|
||||
urlValues := r.URL.Query() |
||||
frameFormat := pushurl.FrameFormatFromValues(urlValues) |
||||
|
||||
logger.Debug("Live Push request", |
||||
"protocol", "http", |
||||
"streamId", streamID, |
||||
"bodyLength", len(body), |
||||
"frameFormat", frameFormat, |
||||
) |
||||
|
||||
metricFrames, err := s.converter.Convert(body, frameFormat) |
||||
if err != nil { |
||||
logger.Error("Error converting metrics", "error", err, "frameFormat", frameFormat) |
||||
continue |
||||
} |
||||
|
||||
for _, mf := range metricFrames { |
||||
err := stream.Push(mf.Key(), mf.Frame()) |
||||
if err != nil { |
||||
logger.Error("Error pushing frame", "error", err, "data", string(body)) |
||||
return |
||||
} |
||||
} |
||||
} |
||||
} |
||||
@ -0,0 +1,113 @@ |
||||
package pushws |
||||
|
||||
import ( |
||||
"context" |
||||
"fmt" |
||||
"net/http" |
||||
"net/url" |
||||
"strings" |
||||
"time" |
||||
|
||||
"github.com/gorilla/websocket" |
||||
|
||||
"github.com/grafana/grafana/pkg/infra/log" |
||||
) |
||||
|
||||
var ( |
||||
logger = log.New("live.push_ws") |
||||
) |
||||
|
||||
// Config represents config for Handler.
|
||||
type Config struct { |
||||
// ReadBufferSize is a parameter that is used for raw websocket Upgrader.
|
||||
// If set to zero reasonable default value will be used.
|
||||
ReadBufferSize int |
||||
|
||||
// WriteBufferSize is a parameter that is used for raw websocket Upgrader.
|
||||
// If set to zero reasonable default value will be used.
|
||||
WriteBufferSize int |
||||
|
||||
// MessageSizeLimit sets the maximum size in bytes of allowed message from client.
|
||||
// By default DefaultWebsocketMessageSizeLimit will be used.
|
||||
MessageSizeLimit int |
||||
|
||||
// CheckOrigin func to provide custom origin check logic,
|
||||
// zero value means same host check.
|
||||
CheckOrigin func(r *http.Request) bool |
||||
|
||||
// PingInterval sets interval server will send ping messages to clients.
|
||||
// By default DefaultWebsocketPingInterval will be used.
|
||||
PingInterval time.Duration |
||||
} |
||||
|
||||
func sameHostOriginCheck() func(r *http.Request) bool { |
||||
return func(r *http.Request) bool { |
||||
err := checkSameHost(r) |
||||
if err != nil { |
||||
logger.Warn("Origin check failure", "origin", r.Header.Get("origin"), "error", err) |
||||
return false |
||||
} |
||||
return true |
||||
} |
||||
} |
||||
|
||||
func checkSameHost(r *http.Request) error { |
||||
origin := r.Header.Get("Origin") |
||||
if origin == "" { |
||||
return nil |
||||
} |
||||
u, err := url.Parse(origin) |
||||
if err != nil { |
||||
return fmt.Errorf("failed to parse Origin header %q: %w", origin, err) |
||||
} |
||||
if strings.EqualFold(r.Host, u.Host) { |
||||
return nil |
||||
} |
||||
return fmt.Errorf("request Origin %q is not authorized for Host %q", origin, r.Host) |
||||
} |
||||
|
||||
// Defaults.
|
||||
const ( |
||||
DefaultWebsocketPingInterval = 25 * time.Second |
||||
DefaultWebsocketMessageSizeLimit = 1024 * 1024 // 1MB
|
||||
) |
||||
|
||||
func setupWSConn(ctx context.Context, conn *websocket.Conn, config Config) { |
||||
pingInterval := config.PingInterval |
||||
if pingInterval == 0 { |
||||
pingInterval = DefaultWebsocketPingInterval |
||||
} |
||||
messageSizeLimit := config.MessageSizeLimit |
||||
if messageSizeLimit == 0 { |
||||
messageSizeLimit = DefaultWebsocketMessageSizeLimit |
||||
} |
||||
|
||||
if messageSizeLimit > 0 { |
||||
conn.SetReadLimit(int64(messageSizeLimit)) |
||||
} |
||||
if pingInterval > 0 { |
||||
pongWait := pingInterval * 10 / 9 |
||||
_ = conn.SetReadDeadline(time.Now().Add(pongWait)) |
||||
conn.SetPongHandler(func(string) error { |
||||
_ = conn.SetReadDeadline(time.Now().Add(pongWait)) |
||||
return nil |
||||
}) |
||||
} |
||||
|
||||
go func() { |
||||
ticker := time.NewTicker(25 * time.Second) |
||||
defer ticker.Stop() |
||||
for { |
||||
select { |
||||
case <-ctx.Done(): |
||||
return |
||||
case <-ticker.C: |
||||
deadline := time.Now().Add(pingInterval / 2) |
||||
err := conn.WriteControl(websocket.PingMessage, nil, deadline) |
||||
if err != nil { |
||||
return |
||||
} |
||||
} |
||||
} |
||||
}() |
||||
} |
||||
Loading…
Reference in new issue