mirror of
https://github.com/grafana/grafana.git
synced 2024-12-01 21:19:28 -06:00
6dbe3b555f
Adding support for backend plugin client middlewares. This allows headers in outgoing backend plugin and HTTP requests to be modified using client middlewares. The following client middlewares added: Forward cookies: Will forward incoming HTTP request Cookies to outgoing plugins.Client and HTTP requests if the datasource has enabled forwarding of cookies (keepCookies). Forward OAuth token: Will set OAuth token headers on outgoing plugins.Client and HTTP requests if the datasource has enabled Forward OAuth Identity (oauthPassThru). Clear auth headers: Will clear any outgoing HTTP headers that was part of the incoming HTTP request and used when authenticating to Grafana. The current suggested way to register client middlewares is to have a separate package, pluginsintegration, responsible for bootstrap/instantiate the backend plugin client with middlewares and/or longer term bootstrap/instantiate plugin management. Fixes #54135 Related to #47734 Related to #57870 Related to #41623 Related to #57065
91 lines
2.8 KiB
Go
91 lines
2.8 KiB
Go
package api
|
|
|
|
import (
|
|
"errors"
|
|
"fmt"
|
|
"net/http"
|
|
|
|
"github.com/grafana/grafana-plugin-sdk-go/backend"
|
|
|
|
"github.com/grafana/grafana/pkg/api/dtos"
|
|
"github.com/grafana/grafana/pkg/api/response"
|
|
"github.com/grafana/grafana/pkg/models"
|
|
"github.com/grafana/grafana/pkg/services/datasources"
|
|
"github.com/grafana/grafana/pkg/services/featuremgmt"
|
|
"github.com/grafana/grafana/pkg/web"
|
|
)
|
|
|
|
func (hs *HTTPServer) handleQueryMetricsError(err error) *response.NormalResponse {
|
|
if errors.Is(err, datasources.ErrDataSourceAccessDenied) {
|
|
return response.Error(http.StatusForbidden, "Access denied to data source", err)
|
|
}
|
|
if errors.Is(err, datasources.ErrDataSourceNotFound) {
|
|
return response.Error(http.StatusNotFound, "Data source not found", err)
|
|
}
|
|
|
|
var secretsPlugin datasources.ErrDatasourceSecretsPluginUserFriendly
|
|
if errors.As(err, &secretsPlugin) {
|
|
return response.Error(http.StatusInternalServerError, fmt.Sprint("Secrets Plugin error: ", err.Error()), err)
|
|
}
|
|
|
|
return response.ErrOrFallback(http.StatusInternalServerError, "Query data error", err)
|
|
}
|
|
|
|
// QueryMetricsV2 returns query metrics.
|
|
// swagger:route POST /ds/query ds queryMetricsWithExpressions
|
|
//
|
|
// DataSource query metrics with expressions.
|
|
//
|
|
// If you are running Grafana Enterprise and have Fine-grained access control enabled
|
|
// you need to have a permission with action: `datasources:query`.
|
|
//
|
|
// Responses:
|
|
// 200: queryMetricsWithExpressionsRespons
|
|
// 207: queryMetricsWithExpressionsRespons
|
|
// 401: unauthorisedError
|
|
// 400: badRequestError
|
|
// 403: forbiddenError
|
|
// 500: internalServerError
|
|
func (hs *HTTPServer) QueryMetricsV2(c *models.ReqContext) response.Response {
|
|
reqDTO := dtos.MetricRequest{}
|
|
if err := web.Bind(c.Req, &reqDTO); err != nil {
|
|
return response.Error(http.StatusBadRequest, "bad request data", err)
|
|
}
|
|
|
|
resp, err := hs.queryDataService.QueryData(c.Req.Context(), c.SignedInUser, c.SkipCache, reqDTO)
|
|
if err != nil {
|
|
return hs.handleQueryMetricsError(err)
|
|
}
|
|
return hs.toJsonStreamingResponse(resp)
|
|
}
|
|
|
|
func (hs *HTTPServer) toJsonStreamingResponse(qdr *backend.QueryDataResponse) response.Response {
|
|
statusWhenError := http.StatusBadRequest
|
|
if hs.Features.IsEnabled(featuremgmt.FlagDatasourceQueryMultiStatus) {
|
|
statusWhenError = http.StatusMultiStatus
|
|
}
|
|
|
|
statusCode := http.StatusOK
|
|
for _, res := range qdr.Responses {
|
|
if res.Error != nil {
|
|
statusCode = statusWhenError
|
|
}
|
|
}
|
|
|
|
return response.JSONStreaming(statusCode, qdr)
|
|
}
|
|
|
|
// swagger:parameters queryMetricsWithExpressions
|
|
type QueryMetricsWithExpressionsBodyParams struct {
|
|
// in:body
|
|
// required:true
|
|
Body dtos.MetricRequest `json:"body"`
|
|
}
|
|
|
|
// swagger:response queryMetricsWithExpressionsRespons
|
|
type QueryMetricsWithExpressionsRespons struct {
|
|
// The response message
|
|
// in: body
|
|
Body *backend.QueryDataResponse `json:"body"`
|
|
}
|