Skip to content
Managing go application shutdown with signals.
Go
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
vendor remove unused deps Jul 7, 2018
.gitignore
.travis.yml
LICENSE Initial commit Mar 9, 2015
README.md remove extra point Aug 17, 2018
death.go just make one package Jun 28, 2018
death_unix_test.go fix case where errors not bubbling up Jun 27, 2018
death_windows_test.go add a test to validate this works in windows Jun 1, 2015
deathlog.go just make one package Jun 28, 2018
pkgPath_test.go fix case where errors not bubbling up Jun 27, 2018

README.md

Death Build Status Coverage Status

Join the chat at https://gitter.im/vrecan/death

Simple library to make it easier to manage the death of your application.

Get The Library

Use gopkg.in to import death based on your logger.

Version Go Get URL source doc Notes
3.x gopkg.in/vrecan/death.v3 source doc This removes the need for an independent logger. By default death will not log but will return an error if all the closers do not properly close. If you want to provide a logger just satisfy the deathlog.Logger interface.
2.x gopkg.in/vrecan/death.v2 source doc This supports loggers who do not return an error from their Error and Warn functions like logrus
1.x gopkg.in/vrecan/death.v1 souce doc This supports loggers who do return an error from their Error and Warn functions like seelog

Example

go get gopkg.in/vrecan/death.v3

Use The Library

package main

import (
	DEATH "github.com/vrecan/death"
	SYS "syscall"
)

func main() {
	death := DEATH.NewDeath(SYS.SIGINT, SYS.SIGTERM) //pass the signals you want to end your application
	//when you want to block for shutdown signals
	death.WaitForDeath() // this will finish when a signal of your type is sent to your application
}

Close Other Objects On Shutdown

One simple feature of death is that it can also close other objects when shutdown starts

package main

import (
	"log"
	DEATH "github.com/vrecan/death"
	SYS "syscall"
	"io"
)

func main() {
	death := DEATH.NewDeath(SYS.SIGINT, SYS.SIGTERM) //pass the signals you want to end your application
	objects := make([]io.Closer, 0)

	objects = append(objects, &NewType{}) // this will work as long as the type implements a Close method

	//when you want to block for shutdown signals
	err := death.WaitForDeath(objects...) // this will finish when a signal of your type is sent to your application
	if err != nil {
		log.Println(err)
		os.Exit(1)
	}
}

type NewType struct {
}

func (c *NewType) Close() error {
	return nil
}

Or close using an anonymous function

package main

import (
	DEATH "github.com/vrecan/death"
	SYS "syscall"
)

func main() {
	death := DEATH.NewDeath(SYS.SIGINT, SYS.SIGTERM) //pass the signals you want to end your application
	//when you want to block for shutdown signals
	death.WaitForDeathWithFunc(func(){ 
		//do whatever you want on death
	}) 
}

Release Process

Rules for release branches:

  • If you are releasing a new major version you need to branch off of master into a branch release-branch.v# (example release-branch.v2 for a 2.x release)
  • If you are releasing a minor or patch update to an existing major release make sure to merge master into the release branch

Rules for tagging and publishing the release

When you are ready to publish the release make sure you...

  1. Merge your changes into the correct release branch.
  2. Check out the release branch locally (example: git pull origin release-branch.v3)
  3. Create a new tag for the specific release version you will publish (example: git tag v3.0.1)
  4. Push the tag up to github (example: git push origin v3.0.1)
  5. Go to the release tab in github
  6. Select the target branch as the release branch and type in the tag name (tagname should include v so example: v3.0.1)
  7. Write a title and a well worded description on exactly what is in this change
  8. Click publish release
You can’t perform that action at this time.