Documentation

Overview

    Package health provides some utility functions to health-check a server. The implementation is based on protobuf. Users need to write their own implementations if other IDLs are used.

    Index

    Constants

    This section is empty.

    Variables

    This section is empty.

    Functions

    This section is empty.

    Types

    type Server

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

      Server implements `service Health`.

      func NewServer

      func NewServer() *Server

        NewServer returns a new Server.

        func (*Server) Check

          Check implements `service Health`.

          func (*Server) SetServingStatus

          func (s *Server) SetServingStatus(service string, status healthpb.HealthCheckResponse_ServingStatus)

            SetServingStatus is called when need to reset the serving status of a service or insert a new service entry into the statusMap.

            Source Files

            Directories

            Path Synopsis