bosun

module

v0.0.0-...-fc99e3f Latest Latest Go to latest Published: Nov 15, 2019 License: MIT

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

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@<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.

Directories ¶

Path	Synopsis
_version Package version holds some version data common to bosun and scollector.	Package version holds some version data common to bosun and scollector.
annotate
backend
cmd/annotate
web
build Simple script to build bosun and scollector.	Simple script to build bosun and scollector.
generate
release
syncTokens
cmd
backfill Backfill denormalizes historic OpenTSDB data.	Backfill denormalizes historic OpenTSDB data.
bosun
bosun/cache
bosun/conf
bosun/conf/rule
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/conf/template Package template is a thin wrapper over go's text/template and html/template packages.	Package template is a thin wrapper over go's text/template and html/template packages.
bosun/database Package database implements all persistent data access for bosun.	Package database implements all persistent data access for bosun.
bosun/database/sentinel
bosun/database/test
bosun/database/test/util
bosun/expr
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.
bosun/ping
bosun/sched
bosun/sched/slack Package slack is for creating slack notifications inside of Bosun templates	Package slack is for creating slack notifications inside of Bosun templates
bosun/search
bosun/web
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/collectors
scollector/conf Package conf contains all of the configuration structs for scollector.	Package conf contains all of the configuration structs for scollector.
silence
snmpTester
tsdbrelay tsdbrelay relays OpenTSDB traffic to TSD and Bosun servers.	tsdbrelay relays OpenTSDB traffic to TSD and Bosun servers.
tsdbrelay/denormalize
tsdbrelay/integrationTest We are going to simulate a full multi-datacenter cluster: DC1: - tsdbrelay: :5555 - opentsdb: :5556 - bosun: :5557 DC2: - tsdbrelay :6555 - opentsdb :6556 - bosun: :6557	We are going to simulate a full multi-datacenter cluster: DC1: - tsdbrelay: :5555 - opentsdb: :5556 - bosun: :5557 DC2: - tsdbrelay :6555 - opentsdb :6556 - bosun: :6557
collect Package collect provides functions for sending data to OpenTSDB.	Package collect provides functions for sending data to OpenTSDB.
graphite Package graphite defines structures for interacting with a Graphite server.	Package graphite defines structures for interacting with a Graphite server.
metadata Package metadata provides metadata information between bosun and OpenTSDB.	Package metadata provides metadata information between bosun and OpenTSDB.
models
opentsdb Package opentsdb defines structures for interacting with an OpenTSDB server.	Package opentsdb defines structures for interacting with an OpenTSDB server.
slog Package slog provides a cross-platform logging interface.	Package slog provides a cross-platform logging interface.
snmp 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.
util Package util defines utilities for bosun.	Package util defines utilities for bosun.

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL