healthcheck

Documentation

Overview

Package healthcheck tests and communicates the health of the Cloud SQL Auth proxy.

Index

• type Server
  • func NewServer(c *proxy.Client, port string, staticInst []string) (*Server, error)
  • func (s *Server) Close(ctx context.Context) error
  • func (s *Server) NotifyStarted()

Types

type Server

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

Server is a type used to implement health checks for the proxy.

func NewServer

func NewServer(c *proxy.Client, port string, staticInst []string) (*Server, error)

NewServer initializes a Server and exposes HTTP endpoints used to communicate proxy health.

func (*Server) Close

func (s *Server) Close(ctx context.Context) error

Close gracefully shuts down the HTTP server belonging to the Server.

func (*Server) NotifyStarted

func (s *Server) NotifyStarted()

NotifyStarted tells the Server that the proxy has finished startup.