github.com/bookingcom/grace
go get github.com/bookingcom/grace

github.com/bookingcom/grace

Graceful restart & zero downtime deploy for Go servers.

by bookingcom

v1.6.2-bcom (see all)License:MIT
go get github.com/bookingcom/grace
Readme

grace Build Status

Package grace provides a library that makes it easy to build socket based servers that can be gracefully terminated & restarted (that is, without dropping any connections).

It provides a convenient API for HTTP servers including support for TLS, especially if you need to listen on multiple ports (for example a secondary internal only admin server). Additionally it is implemented using the same API as systemd providing socket activation compatibility to also provide lazy activation of the server.

Usage

Demo HTTP Server with graceful termination and restart: https://github.com/bookingcom/blob/master/gracedemo/demo.go

  1. Install the demo application

     go get github.com/bookingcom/gracedemo
    
  2. Start it in the first terminal

     gracedemo
    

    This will output something like:

     2013/03/25 19:07:33 Serving [::]:48567, [::]:48568, [::]:48569 with pid 14642.
    
  3. In a second terminal start a slow HTTP request

     curl 'http://localhost:48567/sleep/?duration=20s'
    
  4. In a third terminal trigger a graceful server restart (using the pid from your output):

     kill -USR2 14642
    
  5. Trigger another shorter request that finishes before the earlier request:

     curl 'http://localhost:48567/sleep/?duration=0s'
    

If done quickly enough, this shows the second quick request will be served by the new process (as indicated by the PID) while the slow first request will be served by the first server. It shows how the active connection was gracefully served before the server was shutdown. It is also showing that at one point both the new as well as the old server was running at the same time.

Documentation

http.Server graceful termination and restart: https://godoc.org/github.com/bookingcom/gracehttp

net.Listener graceful termination and restart: https://godoc.org/github.com/bookingcom/gracenet

GitHub Stars

11

LAST COMMIT

1yr ago

MAINTAINERS

0

CONTRIBUTORS

14

OPEN ISSUES

0

OPEN PRs

1
VersionTagPublished
v1.6.2-bcom
1yr ago
v1.6.0-bcom
2yrs ago
v0.0.0-20180706040059-75cf19382434
2yrs ago
v1.6.1-bcom
2yrs ago
No alternatives found
No tutorials found
Add a tutorial