grpc_middleware

package

v1.41.1 Latest Latest Go to latest Published: May 1, 2024 License: GPL-3.0 Imports: 24 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/flipt-io/flipt

Links

Open Source Insights

Documentation ¶

Index ¶

func AuditUnaryInterceptor(logger *zap.Logger, eventPairChecker EventPairChecker) grpc.UnaryServerInterceptor
func CacheUnaryInterceptor(cache cache.Cacher, logger *zap.Logger) grpc.UnaryServerInterceptor
func ErrorUnaryInterceptor(ctx context.Context, req interface{}, _ *grpc.UnaryServerInfo, ...) (resp interface{}, err error)
func EvaluationUnaryInterceptor(analyticsEnabled bool) grpc.UnaryServerInterceptor
func FliptAcceptServerVersionFromContext(ctx context.Context) semver.Version
func FliptAcceptServerVersionUnaryInterceptor(logger *zap.Logger) grpc.UnaryServerInterceptor
func ValidationUnaryInterceptor(ctx context.Context, req interface{}, _ *grpc.UnaryServerInfo, ...) (resp interface{}, err error)
func WithFliptAcceptServerVersion(ctx context.Context, version semver.Version) context.Context
type EventPairChecker
type RequestIdentifiable
type ResponseDurationRecordable

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func AuditUnaryInterceptor ¶ added in v1.21.0

func AuditUnaryInterceptor(logger *zap.Logger, eventPairChecker EventPairChecker) grpc.UnaryServerInterceptor

AuditUnaryInterceptor sends audit logs to configured sinks upon successful RPC requests for auditable events.

func CacheUnaryInterceptor ¶

func CacheUnaryInterceptor(cache cache.Cacher, logger *zap.Logger) grpc.UnaryServerInterceptor

CacheUnaryInterceptor caches the response of a request if the request is cacheable. TODO: we could clean this up by using generics in 1.18+ to avoid the type switch/duplicate code.

func ErrorUnaryInterceptor ¶

func ErrorUnaryInterceptor(ctx context.Context, req interface{}, _ *grpc.UnaryServerInfo, handler grpc.UnaryHandler) (resp interface{}, err error)

ErrorUnaryInterceptor intercepts known errors and returns the appropriate GRPC status code

func EvaluationUnaryInterceptor ¶

func EvaluationUnaryInterceptor(analyticsEnabled bool) grpc.UnaryServerInterceptor

EvaluationUnaryInterceptor sets required request/response fields. Note: this should be added before any caching interceptor to ensure the request id/response fields are unique.

func FliptAcceptServerVersionFromContext ¶ added in v1.38.0

func FliptAcceptServerVersionFromContext(ctx context.Context) semver.Version

FliptAcceptServerVersionFromContext returns the flipt-accept-server-version from the context if it exists or the default version.

func FliptAcceptServerVersionUnaryInterceptor ¶ added in v1.38.0

func FliptAcceptServerVersionUnaryInterceptor(logger *zap.Logger) grpc.UnaryServerInterceptor

FliptAcceptServerVersionUnaryInterceptor is a grpc client interceptor that sets the flipt-accept-server-version in the context if provided in the metadata/header.

func ValidationUnaryInterceptor ¶

func ValidationUnaryInterceptor(ctx context.Context, req interface{}, _ *grpc.UnaryServerInfo, handler grpc.UnaryHandler) (resp interface{}, err error)

ValidationUnaryInterceptor validates incoming requests

func WithFliptAcceptServerVersion ¶ added in v1.38.0

func WithFliptAcceptServerVersion(ctx context.Context, version semver.Version) context.Context

WithFliptAcceptServerVersion sets the flipt version in the context.

Types ¶

type EventPairChecker ¶ added in v1.27.0

type EventPairChecker interface {
	Check(eventPair string) bool
}

EventPairChecker is the middleware side contract for checking if an event pair exists.

type RequestIdentifiable ¶ added in v1.24.0

type RequestIdentifiable interface {
	// SetRequestIDIfNotBlank attempts to set the provided ID on the instance
	// If the ID was blank, it returns the ID provided to this call.
	// If the ID was not blank, it returns the ID found on the instance.
	SetRequestIDIfNotBlank(id string) string
}

type ResponseDurationRecordable ¶ added in v1.24.0

type ResponseDurationRecordable interface {
	// SetTimestamps records the start and end times on the target instance.
	SetTimestamps(start, end time.Time)
}

Source Files ¶

View all Source files

middleware.go

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL