bosun's Introduction

bosun

Bosun is a time series alerting framework developed by Stack Exchange. Scollector is a metric collection agent. Learn more at bosun.org.

building

To build bosun and scollector, clone to $GOPATH/src/bosun.org:

$ go get bosun.org/cmd/bosun

bosun and scollector are found under the cmd directory. Run go build in the corresponding directories to build each project.

developing

Install:

npm install typescript@<version> -g to be able to compile the ts files to js files. The current version of typescript to install will be in the .tavis.yml file in the root of this repo.
go get github.com/mjibson/esc to embed the static files. Run go generate in cmd/bosun when new static assets (like JS and CSS files) are added or changed.

The w.sh script will automatically build and run bosun in a loop. It will update itself when go/js/ts files change, and it runs in read-only mode, not sending any alerts.

$ cd cmd/bosun
$ ./w.sh

Go Version:

See the version number in .travis.yml in the root of this repo for the version of Go to use. Generally speaking, you should be able to use newer versions of Go if you are able to build Bosun without error.

Miniprofiler:

Bosun includes miniprofiler in the web UI which can help with debugging. The key combination ALT-P will show miniprofiler. This allows you to see timings, as well as the raw queries sent to TSDBs.

Recommend Projects