README
¶
server-starter
Go port of start_server utility (a.k.a. Server::Starter).
DESCRIPTION
note: this description is almost entirely taken from the original Server::Starter module
The start_server utility is a superdaemon for hot-deploying server programs.
It is often a pain to write a server program that supports graceful restarts, with no resource leaks. Server::Starter solves the problem by splitting the task into two: start_server works as a superdaemon that binds to zero or more TCP ports or unix sockets, and repeatedly spawns the server program that actually handles the necessary tasks (for example, responding to incoming connections). The spawned server programs under start_server call accept(2) and handle the requests.
To gracefully restart the server program, send SIGHUP to the superdaemon. The superdaemon spawns a new server program, and if (and only if) it starts up successfully, sends SIGTERM to the old server program.
By using start_server it is much easier to write a hot-deployable server. Following are the only requirements a server program to be run under start_server should conform to:
- receive file descriptors to listen to through an environment variable - perform a graceful shutdown when receiving SIGTERM
Many PSGI servers support this. If you want your Go program to support it, you can look under the listener directory for an implementation that also fills the net.Listener interface.
INSTALLATION
go get github.com/lestrrat-go/server-starter/cmd/start_server
Documentation
¶
Index ¶
- func GetLogger() *slog.Logger
- func InitLogger(format LogFormat)
- func LogDebug(msg string, args ...any)
- func LogError(msg string, args ...any)
- func LogInfo(msg string, args ...any)
- func LogWarn(msg string, args ...any)
- func SigFromName(n string) os.Signal
- type Config
- type LogFormat
- type Starter
- type WorkerState
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func InitLogger ¶
func InitLogger(format LogFormat)
InitLogger initializes the global logger with the specified format
func SigFromName ¶
SigFromName returns the signal corresponding to the given signal name string. If the given name string is not defined, it returns nil.
Types ¶
type Config ¶
type Config interface {
Args() []string
Command() string
Dir() string // Directory to chdir to before executing the command
Interval() time.Duration // Time between checks for liveness
PidFile() string
Ports() []string // Ports to bind to (addr:port or port, so it's a string)
Paths() []string // Paths (UNIX domain socket) to bind to
SignalOnHUP() os.Signal // Signal to send when HUP is received
SignalOnTERM() os.Signal // Signal to send when TERM is received
StatusFile() string
LogFormat() string // Log output format (text or json)
}
type Starter ¶
type Starter struct {
// contains filtered or unexported fields
}
func NewStarter ¶
NewStarter creates a new Starter object. Config parameter may NOT be nil, as `Ports` and/or `Paths`, and `Command` are required
func (*Starter) StartWorker ¶
StartWorker starts the actual command.
Source Files
Directories