allen13/golerta repository overview

⁠Golerta

A simplified reimplementation of alerta⁠ in golang.

Rethinkdb is used instead of Mongodb for operational simplicity and real-time data features.

⁠features

• All-in-one server - static content, api, and continuous queries
• LDAP Authentication
• OAuth Authenticaion
• Alert routing via plugins - current plugins: file, pagerduty
• Optional alert time outs - if an alert has a timeout field it will escalate to critical if a new alert isn't received within a given amount of time
• Timed acknowledgements - alerts will reopen after a specified amount of time
• Flap detection - alerts that continually change severity state will be marked as flapping
• Select and update alerts from the list view
• IN DEVELOPMENT: Web sockets on the client side - web browser no longer polls and new alerts are received immediately
• IN DEVELOPMENT: Fully distributed - Currently the continuous queries can only be run on a single node without duplicating effort.

⁠configuration

Golerta uses Viper⁠ for configuration. This supports a wide variety of formats, including JSON, YAML, TOML, and HCL. See docker-example/example.toml for an example configuration. In addition to a config file, environment variables can be set to match the configuration. Variables are prefixed with GOLERTA_, followed by the main section (such as LDAP_), then the value (all together GOLERTA_LDAP_HOST). For example, the parent app structure would look like the following JSON {"app": {"bind_addr": 5608, "signing_key": "super_secret_signing_key"}}, the equivalent environment variable is GOLERTA_APP_BIND_ADDR. This is very useful for docker containers.

⁠docker image

Example: Run golerta minimal

docker run -p 5608:5608 -e RETHINKDB_ADDRESS=your-rethinkdb-host:28015 -e allen13/golerta:latest

Example: Run golerta by linking to both the rethinkdb and smtp service containers.

docker run -p 5608:5608 --link rethinkdb:rethinkdb --link smtp:smtp -e GOLERTA_RETHINKDB_ADDRESS=rethinkdb:28015 -e GOLERTA_EMAIL_NOTIFIER_ENABLED=true -e GOLERTA_EMAIL_SMTP_SERVER=smtp golerta

Example: Using composer for a full tick stack, including an example toml file

cd docker-compose.yml
docker-compose up -d

Example: Getting an agent auth token (where $GOLERTA is the docker container ID or name) from a docker container

docker exec -it $GOLERTA /golerta createAgentToken gauss

⁠development environment

Run rethinkdb in a container on localhost

docker run -d --name rethinkdb -p 8080:8080 -p 28015:28015 rethinkdb

Run postfix in a container on localhost docker run -p 25:25 --name smtp -e maildomain=localhost -e smtp_user=test1:password,test2:password -d catatnight/postfix

Get golerta code and run it with the example config.

go get github.com/allen13/golerta
cd $GOPATH/github.com/allen13/golerta
go run golerta.go server --config golerta.toml

Log in using credentials from the forumsys test ldap server⁠

username: gauss
password: password

Run all unit tests:

go test ./app/...

If RethinkDB is not available, or relevant to the given tests, SKIP_RETHINKDB=true can be set to skip database related tests.