README
¶
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 -gto be able to compile the ts files to js files.go get github.com/mjibson/escto embed the static files. Rungo generateincmd/bosunwhen 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:
- We generally upgrade to the latest version Go within a day or two. So consider the correct version of Go always to be the latest stable release.
Directories
¶
| Path | Synopsis |
|---|---|
|
Package version holds some version data common to bosun and scollector.
|
Package version holds some version data common to bosun and scollector. |
|
Simple script to build bosun and scollector.
|
Simple script to build bosun and scollector. |
|
cmd
|
|
|
backfill
Backfill denormalizes historic OpenTSDB data.
|
Backfill denormalizes historic OpenTSDB data. |
|
bosun/conf/rule/parse
Package parse builds parse trees for configurations as defined by conf.
|
Package parse builds parse trees for configurations as defined by conf. |
|
bosun/database
Package database implements all persistent data access for bosun.
|
Package database implements all persistent data access for bosun. |
|
bosun/expr/parse
Package parse builds parse trees for expressions as defined by expr.
|
Package parse builds parse trees for expressions as defined by expr. |
|
scollector
Scollector is a metric collection agent for OpenTSDB 2.0 and Bosun.
|
Scollector is a metric collection agent for OpenTSDB 2.0 and Bosun. |
|
scollector/conf
Package conf contains all of the configuration structs for scollector.
|
Package conf contains all of the configuration structs for scollector. |
|
tsdbrelay
tsdbrelay relays OpenTSDB traffic to TSD and Bosun servers.
|
tsdbrelay relays OpenTSDB traffic to TSD and Bosun servers. |
|
tsdbrelay/integrationTest
We are going to simulate a full multi-datacenter cluster: DC1:
|
We are going to simulate a full multi-datacenter cluster: DC1: |
|
Package collect provides functions for sending data to OpenTSDB.
|
Package collect provides functions for sending data to OpenTSDB. |
|
Package graphite defines structures for interacting with a Graphite server.
|
Package graphite defines structures for interacting with a Graphite server. |
|
Package metadata provides metadata information between bosun and OpenTSDB.
|
Package metadata provides metadata information between bosun and OpenTSDB. |
|
Package opentsdb defines structures for interacting with an OpenTSDB server.
|
Package opentsdb defines structures for interacting with an OpenTSDB server. |
|
Package slog provides a cross-platform logging interface.
|
Package slog provides a cross-platform logging interface. |
|
Package snmp provides an implementation of the SNMP specification.
|
Package snmp provides an implementation of the SNMP specification. |
|
asn1
Package asn1 implements parsing of DER-encoded ASN.1 data structures, as defined in ITU-T Rec X.690.
|
Package asn1 implements parsing of DER-encoded ASN.1 data structures, as defined in ITU-T Rec X.690. |
|
mib
Package mib parses modules of the virtual management information store.
|
Package mib parses modules of the virtual management information store. |
|
Package util defines utilities for bosun.
|
Package util defines utilities for bosun. |
|
Package vsphere provides a small set of the vSphere Web Services API.
|
Package vsphere provides a small set of the vSphere Web Services API. |
Click to show internal directories.
Click to hide internal directories.