health

Documentation

Overview

Package health contains the service that check the health of an OpenFGA server.

Index

• type Checker
  • func (o *Checker) AuthFuncOverride(ctx context.Context, fullMethodName string) (context.Context, error)
  • func (o *Checker) Check(ctx context.Context, req *healthv1pb.HealthCheckRequest) (*healthv1pb.HealthCheckResponse, error)
  • func (o *Checker) Watch(req *healthv1pb.HealthCheckRequest, server healthv1pb.Health_WatchServer) error
• type TargetService

Types

type Checker

type Checker struct {
	healthv1pb.UnimplementedHealthServer
	TargetService
	TargetServiceName string
}

func (*Checker) AuthFuncOverride

func (o *Checker) AuthFuncOverride(ctx context.Context, fullMethodName string) (context.Context, error)

AuthFuncOverride implements the grpc_auth.ServiceAuthFuncOverride interface by bypassing authn middleware.

func (*Checker) Check

func (o *Checker) Check(ctx context.Context, req *healthv1pb.HealthCheckRequest) (*healthv1pb.HealthCheckResponse, error)

func (*Checker) Watch

func (o *Checker) Watch(req *healthv1pb.HealthCheckRequest, server healthv1pb.Health_WatchServer) error

type TargetService

type TargetService interface {
	IsReady(ctx context.Context) (bool, error)
}

TargetService defines an interface that services can implement for server health checks.