thundersnake

ThunderSnake

ThunderSnake is an application framework designed to bootstrap a Golang application easily with all required tooling to make it work properly in a production environment.

Example

Basic bootstrap

Here is how to bootstrap your application

// Define appServer singleton
var appServer *thundersnake.AppServer

func main() {
	configFile := "/etc/myapp/myapp.yml"
	appServer = thundersnake.NewAppServer(AppName, configFile, onStart)
	if appServer != nil {
		// Appserver will be started
		// * Logging manager will start
		// * Configuration will be loaded
		// * AppServer hooks are launched
		// * onStart callback function is called
		appServer.Start()
	}
}

// When appServer is ready it will call this callback function
func onStart() error {
	appServer.Log.Info("Application started")
	// Do your main code here
	appServer.Log.Info("Application Ended")
}

Custom configuration

We provide an interface if you want to include custom configuration in application configuration file.

First define a configuration structure depending on thundersnake CustomConfig object and implement loadDefaults() function:

type myConfig struct {
	thundersnake.CustomConfig
	foo int `yaml:"foo"`
	bar string `yaml:"bar"`
}

func (c *myConfig) loadDefaults() {
	c.foo = 1
	c.bar = "test"
}

Then overwrite the CustomConfig function in your main app just after creating application server.

var GConfig myConfig

func main() {
	configFile := "/etc/myapp/myapp.yml"
	appServer = thundersnake.NewAppServer(AppName, configFile, onStart)
	appServer.Config.Custom = &GConfig
	if appServer != nil {
		appServer.Start()
	}
}