Plugins: Enhanced plugin instrumentation (#90199)

* Plugins: Enhanced plugin instrumentation * use backend.CallResourceResponseSenderFunc * sdk v0.237.0 * support admission control * cover all handlers in log and metrics middlewares * fix after review
2024-07-09 15:03:46 +02:00
parent 2a4a73e03d
commit c8af659f02
40 changed files with 700 additions and 472 deletions
@@ -0,0 +1,104 @@
+package instrumentationutils
+
+import (
+	"context"
+	"errors"
+	"strings"
+
+	grpccodes "google.golang.org/grpc/codes"
+	grpcstatus "google.golang.org/grpc/status"
+
+	"github.com/grafana/grafana-plugin-sdk-go/backend"
+	"github.com/grafana/grafana-plugin-sdk-go/genproto/pluginv2"
+)
+
+type RequestStatus int
+
+const (
+	RequestStatusOK RequestStatus = iota
+	RequestStatusCancelled
+	RequestStatusError
+)
+
+func (status RequestStatus) String() string {
+	names := [...]string{"ok", "cancelled", "error"}
+	if status < RequestStatusOK || status > RequestStatusError {
+		return ""
+	}
+
+	return names[status]
+}
+
+func RequestStatusFromError(err error) RequestStatus {
+	status := RequestStatusOK
+	if err != nil {
+		status = RequestStatusError
+		if errors.Is(err, context.Canceled) || grpcstatus.Code(err) == grpccodes.Canceled {
+			status = RequestStatusCancelled
+		}
+	}
+
+	return status
+}
+
+func RequestStatusFromErrorString(errString string) RequestStatus {
+	status := RequestStatusOK
+	if errString != "" {
+		status = RequestStatusError
+		if strings.Contains(errString, context.Canceled.Error()) || strings.Contains(errString, "code = Canceled") {
+			status = RequestStatusCancelled
+		}
+	}
+
+	return status
+}
+
+func RequestStatusFromQueryDataResponse(res *backend.QueryDataResponse, err error) RequestStatus {
+	if err != nil {
+		return RequestStatusFromError(err)
+	}
+
+	status := RequestStatusOK
+
+	if res != nil {
+		for _, dr := range res.Responses {
+			if dr.Error != nil {
+				s := RequestStatusFromError(dr.Error)
+				if s > status {
+					status = s
+				}
+
+				if status == RequestStatusError {
+					break
+				}
+			}
+		}
+	}
+
+	return status
+}
+
+func RequestStatusFromProtoQueryDataResponse(res *pluginv2.QueryDataResponse, err error) RequestStatus {
+	if err != nil {
+		return RequestStatusFromError(err)
+	}
+
+	status := RequestStatusOK
+
+	if res != nil {
+		for _, dr := range res.Responses {
+			if dr.Error != "" {
+				s := RequestStatusFromErrorString(dr.Error)
+				if s > status {
+					status = s
+				}
+
+				if status == RequestStatusError {
+					break
+				}
+			}
+		}
+	}
+
+	return status
+}