grace

Documentation

Index

• func GetProcessFromFile(pfile string) (*os.Process, error)
• type Addressable
• type Option
  • func WithLogger(l zerolog.Logger) Option
  • func WithPIDFile(fn string) Option
• type Server
• type Serverless
• type Watcher
  • func NewWatcher(opts ...Option) *Watcher
  • func (w *Watcher) Clean()
  • func (w *Watcher) Exit(errc int)
  • func (w *Watcher) GetListeners(servers map[string]Addressable) (map[string]net.Listener, error)
  • func (w *Watcher) SetServerless(s Serverless)
  • func (w *Watcher) SetServers(s []Server)
  • func (w *Watcher) TrapSignals()
  • func (w *Watcher) WritePID() error

Functions

func GetProcessFromFile

func GetProcessFromFile(pfile string) (*os.Process, error)

GetProcessFromFile reads the pidfile and returns the running process or error if the process or file are not available.

Types

type Addressable

type Addressable interface {
	Network() string
	Address() string
}

Addressable is the interface for exposing address info.

type Option

type Option func(w *Watcher)

Option represent an option.

func WithLogger

func WithLogger(l zerolog.Logger) Option

WithLogger adds a logger to the Watcher.

func WithPIDFile

func WithPIDFile(fn string) Option

WithPIDFile specifies the pid file to use.

type Server

type Server interface {
	Start(net.Listener) error
	Serverless
	Addressable
}

Server is the interface that servers like HTTP or gRPC servers need to implement.

type Serverless

type Serverless interface {
	Stop() error
	GracefulStop() error
}

Serverless is the interface that the serverless server implements.

type Watcher

type Watcher struct {
	SL Serverless
	// contains filtered or unexported fields
}

Watcher watches a process for a graceful restart preserving open network sockets to avoid packet loss.

func NewWatcher

func NewWatcher(opts ...Option) *Watcher

NewWatcher creates a Watcher.

func (*Watcher) Clean

func (w *Watcher) Clean()

Clean cleans up existing pid files.

func (*Watcher) Exit

func (w *Watcher) Exit(errc int)

Exit exits the current process cleaning up existing pid files.

func (*Watcher) GetListeners

func (w *Watcher) GetListeners(servers map[string]Addressable) (map[string]net.Listener, error)

GetListeners return grpc listener first and http listener second.

func (*Watcher) SetServerless

func (w *Watcher) SetServerless(s Serverless)

SetServerless sets the serverless that has to be watched.

func (*Watcher) SetServers

func (w *Watcher) SetServers(s []Server)

SetServers sets the list of servers that have to be watched.

func (*Watcher) TrapSignals

func (w *Watcher) TrapSignals()

TrapSignals captures the OS signal.

func (*Watcher) WritePID

func (w *Watcher) WritePID() error

WritePID writes the pid to the configured pid file.