health

Documentation

Index

• func Module() fx.Option
• func RegisterHealthServer(in RegisterHealthServerIn)
• type RegisterHealthServerIn

Functions

func Module

func Module() fx.Option

Module is a module that provides grpc health server for checking services status.

func RegisterHealthServer

func RegisterHealthServer(in RegisterHealthServerIn)

RegisterHealthServer registers health server to grpc_health_v1 api and sets default statuses.

Types

type RegisterHealthServerIn

type RegisterHealthServerIn struct {
	fx.In
	Server       *grpc.Server `name:"default"`
	HealthServer *health.Server
}

RegisterHealthServerIn bundles and annotates parameters.