This is a settings that enables
constructing a metrics gathering component that orchestrates fanning in various
shutdown signals for a system. It currently support OS signals but can be
extended to support other forms.
package main
import (
"context"
"net/http"
signals "github.com/asecurityteam/component-signals"
"github.com/asecurityteam/settings/v2"
)
func main() {
ctx := context.Background()
envSource := settings.NewEnvSource(os.Environ())
sig, _ := signals.New(ctx, envSource)
<-sig
fmt.Println("shut down")
}This project is in incubation which means we are not yet operating this tool in production and the interfaces are subject to change.
We publish a docker image called SDCLI that bundles all of our build dependencies. It is used by the included Makefile to help make building and testing a bit easier. The following actions are available through the Makefile:
-
make dep
Install the project dependencies into a vendor directory
-
make lint
Run our static analysis suite
-
make test
Run unit tests and generate a coverage artifact
-
make integration
Run integration tests and generate a coverage artifact
-
make coverage
Report the combined coverage for unit and integration tests
This project is licensed under Apache 2.0. See LICENSE.txt for details.
Atlassian requires signing a contributor's agreement before we can accept a patch. If you are an individual you can fill out the individual CLA. If you are contributing on behalf of your company then please fill out the corporate CLA.