mirror of
https://github.com/zitadel/zitadel.git
synced 2025-07-13 02:28:31 +00:00
9ebf2316c6
# Which Problems Are Solved The current maintained gRPC server in combination with a REST (grpc) gateway is getting harder and harder to maintain. Additionally, there have been and still are issues with supporting / displaying `oneOf`s correctly. We therefore decided to exchange the server implementation to connectRPC, which apart from supporting connect as protocol, also also "standard" gRCP clients as well as HTTP/1.1 / rest like clients, e.g. curl directly call the server without any additional gateway. # How the Problems Are Solved - All v2 services are moved to connectRPC implementation. (v1 services are still served as pure grpc servers) - All gRPC server interceptors were migrated / copied to a corresponding connectRPC interceptor. - API.ListGrpcServices and API. ListGrpcMethods were changed to include the connect services and endpoints. - gRPC server reflection was changed to a `StaticReflector` using the `ListGrpcServices` list. - The `grpc.Server` interfaces was split into different combinations to be able to handle the different cases (grpc server and prefixed gateway, connect server with grpc gateway, connect server only, ...) - Docs of services serving connectRPC only with no additional gateway (instance, webkey, project, app, org v2 beta) are changed to expose that - since the plugin is not yet available on buf, we download it using `postinstall` hook of the docs # Additional Changes - WebKey service is added as v2 service (in addition to the current v2beta) # Additional Context closes #9483 --------- Co-authored-by: Elio Bischof <elio@zitadel.com>
97 lines
3.6 KiB
Go
97 lines
3.6 KiB
Go
package connect_middleware
|
|
|
|
import (
|
|
"context"
|
|
"strings"
|
|
|
|
"connectrpc.com/connect"
|
|
"github.com/grpc-ecosystem/grpc-gateway/runtime"
|
|
"github.com/zitadel/logging"
|
|
"go.opentelemetry.io/otel/attribute"
|
|
"google.golang.org/grpc/codes"
|
|
|
|
_ "github.com/zitadel/zitadel/internal/statik"
|
|
"github.com/zitadel/zitadel/internal/telemetry/metrics"
|
|
)
|
|
|
|
const (
|
|
GrpcMethod = "grpc_method"
|
|
ReturnCode = "return_code"
|
|
GrpcRequestCounter = "grpc.server.request_counter"
|
|
GrpcRequestCounterDescription = "Grpc request counter"
|
|
TotalGrpcRequestCounter = "grpc.server.total_request_counter"
|
|
TotalGrpcRequestCounterDescription = "Total grpc request counter"
|
|
GrpcStatusCodeCounter = "grpc.server.grpc_status_code"
|
|
GrpcStatusCodeCounterDescription = "Grpc status code counter"
|
|
)
|
|
|
|
func MetricsHandler(metricTypes []metrics.MetricType, ignoredMethodSuffixes ...string) connect.UnaryInterceptorFunc {
|
|
return func(handler connect.UnaryFunc) connect.UnaryFunc {
|
|
return func(ctx context.Context, req connect.AnyRequest) (connect.AnyResponse, error) {
|
|
return RegisterMetrics(ctx, req, handler, metricTypes, ignoredMethodSuffixes...)
|
|
}
|
|
}
|
|
}
|
|
|
|
func RegisterMetrics(ctx context.Context, req connect.AnyRequest, handler connect.UnaryFunc, metricTypes []metrics.MetricType, ignoredMethodSuffixes ...string) (_ connect.AnyResponse, err error) {
|
|
if len(metricTypes) == 0 {
|
|
return handler(ctx, req)
|
|
}
|
|
|
|
for _, ignore := range ignoredMethodSuffixes {
|
|
if strings.HasSuffix(req.Spec().Procedure, ignore) {
|
|
return handler(ctx, req)
|
|
}
|
|
}
|
|
|
|
resp, err := handler(ctx, req)
|
|
if containsMetricsMethod(metrics.MetricTypeRequestCount, metricTypes) {
|
|
RegisterGrpcRequestCounter(ctx, req.Spec().Procedure)
|
|
}
|
|
if containsMetricsMethod(metrics.MetricTypeTotalCount, metricTypes) {
|
|
RegisterGrpcTotalRequestCounter(ctx)
|
|
}
|
|
if containsMetricsMethod(metrics.MetricTypeStatusCode, metricTypes) {
|
|
RegisterGrpcRequestCodeCounter(ctx, req.Spec().Procedure, err)
|
|
}
|
|
return resp, err
|
|
}
|
|
|
|
func RegisterGrpcRequestCounter(ctx context.Context, path string) {
|
|
var labels = map[string]attribute.Value{
|
|
GrpcMethod: attribute.StringValue(path),
|
|
}
|
|
err := metrics.RegisterCounter(GrpcRequestCounter, GrpcRequestCounterDescription)
|
|
logging.OnError(err).Warn("failed to register grpc request counter")
|
|
err = metrics.AddCount(ctx, GrpcRequestCounter, 1, labels)
|
|
logging.OnError(err).Warn("failed to add grpc request count")
|
|
}
|
|
|
|
func RegisterGrpcTotalRequestCounter(ctx context.Context) {
|
|
err := metrics.RegisterCounter(TotalGrpcRequestCounter, TotalGrpcRequestCounterDescription)
|
|
logging.OnError(err).Warn("failed to register total grpc request counter")
|
|
err = metrics.AddCount(ctx, TotalGrpcRequestCounter, 1, nil)
|
|
logging.OnError(err).Warn("failed to add total grpc request count")
|
|
}
|
|
|
|
func RegisterGrpcRequestCodeCounter(ctx context.Context, path string, err error) {
|
|
statusCode := connect.CodeOf(err)
|
|
var labels = map[string]attribute.Value{
|
|
GrpcMethod: attribute.StringValue(path),
|
|
ReturnCode: attribute.IntValue(runtime.HTTPStatusFromCode(codes.Code(statusCode))),
|
|
}
|
|
err = metrics.RegisterCounter(GrpcStatusCodeCounter, GrpcStatusCodeCounterDescription)
|
|
logging.OnError(err).Warn("failed to register grpc status code counter")
|
|
err = metrics.AddCount(ctx, GrpcStatusCodeCounter, 1, labels)
|
|
logging.OnError(err).Warn("failed to add grpc status code count")
|
|
}
|
|
|
|
func containsMetricsMethod(metricType metrics.MetricType, metricTypes []metrics.MetricType) bool {
|
|
for _, m := range metricTypes {
|
|
if m == metricType {
|
|
return true
|
|
}
|
|
}
|
|
return false
|
|
}
|