https://github.com/nhalstead/exitplan
Golang Exit Callback for SIGINT & SIGTERM
https://github.com/nhalstead/exitplan
cli cli-app cobra command command-line commandline go golang golang-application poxis
Last synced: 8 months ago
JSON representation
Golang Exit Callback for SIGINT & SIGTERM
- Host: GitHub
- URL: https://github.com/nhalstead/exitplan
- Owner: nhalstead
- License: apache-2.0
- Created: 2021-05-18T04:18:58.000Z (about 5 years ago)
- Default Branch: main
- Last Pushed: 2021-09-05T17:58:33.000Z (almost 5 years ago)
- Last Synced: 2025-03-11T20:22:58.219Z (over 1 year ago)
- Topics: cli, cli-app, cobra, command, command-line, commandline, go, golang, golang-application, poxis
- Language: Go
- Homepage:
- Size: 48.8 KB
- Stars: 1
- Watchers: 1
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Exit Plan
[](https://goreportcard.com/report/github.com/nhalstead/exitplan)
[](https://godoc.org/github.com/nhalstead/exitplan)
Simple go package to help with the shutdown process within a go program by integrating with SIGINT and SIGTERM.
The purpose is to be used with a container orchestration software like kubernetes where heath checks are done on the pod.
This can be used with or without the use of an HTTP server serving the heath check data.
## Demo and Details
This repo has the example in it already using the [cobra package](https://github.com/spf13/cobra).
Clone down the repo and build it.
Upon running executing `exitplan test`, an HTTP server on port 8855 will be running.
Browse to [http://localhost:8855/readyz](http://localhost:8855/readyz) to check the status!
---
Now that the server is running, and the page is responding with "ok", you can now press COMMAND+C / CTRL+C in the terminal window to trigger a SIGTERM.
After you trigger the SIGTERM, two actions take place. First a flag is set to indicate
it's going to terminate (which changes the response for `/readyz`), then a grace period is waiting to complete.
After the grade period has passed it kicks into action again with a timeout for the deadline of the program to exit.
Before reaching the deadline, goroutines are being made to call the shutdown methods that have been registered.
Lastly before the program exists it makes one last synchronous call to the FinalCallback.
## Usage
```go
package main
import (
"context"
"fmt"
"net/http"
"time"
"github.com/gorilla/mux"
"github.com/nhalstead/exitplan"
)
func main() {
m := mux.NewRouter()
srv := &http.Server{
Handler: m,
Addr: "127.0.0.1:8855",
WriteTimeout: 5 * time.Second,
ReadTimeout: 5 * time.Second,
}
plan := exitplan.NewPlan()
plan.Add("http", srv.Shutdown)
// Register a Request Handler on "/readyz" for the status.
m.HandleFunc("/readyz", plan.HandlerFunc).Methods(http.MethodGet)
go srv.ListenAndServe()
fmt.Println("Server Running")
fmt.Println("Goto http://localhost:8855/readyz")
plan.Finally(func (ctx context.Context) error {
// Do some final cool stuff before death
fmt.Println("final callback made")
return nil
})
plan.Wait(context.TODO())
}
```
## Inspired By
[Gracefully Shutdown your Go Application](https://alfiandnm.medium.com/gracefully-shutdown-your-go-application-9e7d5c73b5ac) by Alfian Dhimas
[Graceful shutdown with Go http servers and Kubernetes rolling updates](https://medium.com/over-engineering/graceful-shutdown-with-go-http-servers-and-kubernetes-rolling-updates-6697e7db17cf) by Wayne Ashley Berry
[Stackoverflow: Testing graceful shutdown on an HTTP server during a Kubernetes rollout](https://stackoverflow.com/a/58752566/5779200)
[terminus *Graceful shutdown and Kubernetes readiness / liveness checks for any Node.js HTTP applications*](https://github.com/godaddy/terminus) by GoDaddy Dev Team