grpc

Documentation

Index

• Constants
• func Flags() *pflag.FlagSet
• type BasicHealthChecker
  • func NewBasicHealthChecker(opts ...Option) *BasicHealthChecker
  • func (s *BasicHealthChecker) Check(_ context.Context, req *grpc_health_v1.HealthCheckRequest) (*grpc_health_v1.HealthCheckResponse, error)
  • func (s *BasicHealthChecker) Watch(_ *grpc_health_v1.HealthCheckRequest, server grpc_health_v1.Health_WatchServer) error
• type MongodbHealthChecker
  • func NewMongoDBHealthChecker(db *mongo.Client, opts ...Option) *MongodbHealthChecker
  • func (s *MongodbHealthChecker) Check(ctx context.Context, req *grpc_health_v1.HealthCheckRequest) (*grpc_health_v1.HealthCheckResponse, error)
  • func (s *MongodbHealthChecker) Watch(_ *grpc_health_v1.HealthCheckRequest, server grpc_health_v1.Health_WatchServer) error
• type MySQLHealthChecker
  • func NewMySQLHealthChecker(db *sqlx.DB, opts ...Option) *MySQLHealthChecker
  • func (s *MySQLHealthChecker) Check(_ context.Context, req *grpc_health_v1.HealthCheckRequest) (*grpc_health_v1.HealthCheckResponse, error)
  • func (s *MySQLHealthChecker) Watch(_ *grpc_health_v1.HealthCheckRequest, server grpc_health_v1.Health_WatchServer) error
• type Option
  • func DisableHealthServer() Option
  • func DisableLoggingInterceptor() Option
  • func DisablePrometheusInterceptor() Option
  • func DisableRequestIdInterceptor() Option
  • func Name(name string) Option
  • func Port(addr string) Option
  • func ShutdownGracePeriod(duration time.Duration) Option
• type Options
• type Server
  • func NewServer(opts ...Option) Server

Constants

const (
	PortConfigKey        = "grpc-port"
	GracePeriodConfigKey = "grpc-grace-period"
)

const (
	HealthUnknown    = 0
	HealthServing    = 1
	HealthNotServing = 2
)

const DefaultGracePeriod = 3 * time.Second

const DefaultHealthEnabled = true

const DefaultLoggingInterceptor = true

const DefaultPort = "50051"

const DefaultPrometheusInterceptor = true

const DefaultRequestIdInterceptor = true

Functions

func Flags

func Flags() *pflag.FlagSet

Flags is a convenience function to quickly add the gRPC server options as CLI flags Implements the cli.FlagProvider type

Types

type BasicHealthChecker

type BasicHealthChecker struct {
	// contains filtered or unexported fields
}

func NewBasicHealthChecker

func NewBasicHealthChecker(opts ...Option) *BasicHealthChecker

func (*BasicHealthChecker) Check

func (s *BasicHealthChecker) Check(_ context.Context, req *grpc_health_v1.HealthCheckRequest) (*grpc_health_v1.HealthCheckResponse, error)

func (*BasicHealthChecker) Watch

func (s *BasicHealthChecker) Watch(_ *grpc_health_v1.HealthCheckRequest, server grpc_health_v1.Health_WatchServer) error

type MongodbHealthChecker

type MongodbHealthChecker struct {
	// contains filtered or unexported fields
}

func NewMongoDBHealthChecker

func NewMongoDBHealthChecker(db *mongo.Client, opts ...Option) *MongodbHealthChecker

func (*MongodbHealthChecker) Check

func (s *MongodbHealthChecker) Check(ctx context.Context, req *grpc_health_v1.HealthCheckRequest) (*grpc_health_v1.HealthCheckResponse, error)

func (*MongodbHealthChecker) Watch

func (s *MongodbHealthChecker) Watch(_ *grpc_health_v1.HealthCheckRequest, server grpc_health_v1.Health_WatchServer) error

type MySQLHealthChecker

type MySQLHealthChecker struct {
	// contains filtered or unexported fields
}

func NewMySQLHealthChecker

func NewMySQLHealthChecker(db *sqlx.DB, opts ...Option) *MySQLHealthChecker

func (*MySQLHealthChecker) Check

func (s *MySQLHealthChecker) Check(_ context.Context, req *grpc_health_v1.HealthCheckRequest) (*grpc_health_v1.HealthCheckResponse, error)

func (*MySQLHealthChecker) Watch

func (s *MySQLHealthChecker) Watch(_ *grpc_health_v1.HealthCheckRequest, server grpc_health_v1.Health_WatchServer) error

type Option

type Option func(*Options)

func DisableHealthServer

func DisableHealthServer() Option

func DisableLoggingInterceptor

func DisableLoggingInterceptor() Option

func DisablePrometheusInterceptor

func DisablePrometheusInterceptor() Option

func DisableRequestIdInterceptor

func DisableRequestIdInterceptor() Option

func Name

func Name(name string) Option

func Port

func Port(addr string) Option

func ShutdownGracePeriod

func ShutdownGracePeriod(duration time.Duration) Option

type Options

type Options struct {
	Port                string
	Name                string
	ShutdownGracePeriod time.Duration
	HealthServerEnabled bool
	// contains filtered or unexported fields
}

type Server

type Server interface {
	ListenAndServe(ctx context.Context, wg *sync.WaitGroup, healthServer grpc_health_v1.HealthServer)
	Server() *grpc.Server
}

func NewServer

func NewServer(opts ...Option) Server