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 |
|---|---|
|
_third_party
|
|
|
code.google.com/p/draw2d/draw2d
The package draw2d provide a Graphic Context that can draw vectorial figure on surface.
|
The package draw2d provide a Graphic Context that can draw vectorial figure on surface. |
|
code.google.com/p/freetype-go/freetype
The freetype package provides a convenient API to draw text onto an image.
|
The freetype package provides a convenient API to draw text onto an image. |
|
code.google.com/p/freetype-go/freetype/raster
The raster package provides an anti-aliasing 2-D rasterizer.
|
The raster package provides an anti-aliasing 2-D rasterizer. |
|
code.google.com/p/freetype-go/freetype/truetype
Package truetype provides a parser for the TTF and TTC file formats.
|
Package truetype provides a parser for the TTF and TTC file formats. |
|
code.google.com/p/graphics-go/graphics/interp
Package interp implements image interpolation.
|
Package interp implements image interpolation. |
|
github.com/MiniProfiler/go/miniprofiler
Package miniprofiler is a simple but effective mini-profiler for websites.
|
Package miniprofiler is a simple but effective mini-profiler for websites. |
|
github.com/PuerkitoBio/goquery
Package goquery implements features similar to jQuery, including the chainable syntax, to manipulate and query an HTML document.
|
Package goquery implements features similar to jQuery, including the chainable syntax, to manipulate and query an HTML document. |
|
github.com/StackExchange/httpunit
Package httpunit tests compliance of net services.
|
Package httpunit tests compliance of net services. |
|
github.com/StackExchange/mof
Package mof parses and marshals Managed Object Format (MOF) structures.
|
Package mof parses and marshals Managed Object Format (MOF) structures. |
|
github.com/StackExchange/wmi
Package wmi provides a WQL interface for WMI on Windows.
|
Package wmi provides a WQL interface for WMI on Windows. |
|
github.com/ajstarks/svgo
Package svg generates SVG as defined by the Scalable Vector Graphics 1.1 Specification (<http://www.w3.org/TR/SVG11/>).
|
Package svg generates SVG as defined by the Scalable Vector Graphics 1.1 Specification (<http://www.w3.org/TR/SVG11/>). |
|
github.com/andybalholm/cascadia
The cascadia package is an implementation of CSS selectors.
|
The cascadia package is an implementation of CSS selectors. |
|
github.com/awslabs/aws-sdk-go/aws
Package aws provides core functionality for making requests to AWS services.
|
Package aws provides core functionality for making requests to AWS services. |
|
github.com/awslabs/aws-sdk-go/aws/awserr
Package of API error interface accessors for the SDK.
|
Package of API error interface accessors for the SDK. |
|
github.com/awslabs/aws-sdk-go/aws/credentials
Package credentials provides credential retrieval and management
|
Package credentials provides credential retrieval and management |
|
github.com/awslabs/aws-sdk-go/internal/apierr
Package of API error types.
|
Package of API error types. |
|
github.com/awslabs/aws-sdk-go/service/cloudwatch
Package cloudwatch provides a client for Amazon CloudWatch.
|
Package cloudwatch provides a client for Amazon CloudWatch. |
|
github.com/awslabs/aws-sdk-go/service/ec2
Package ec2 provides a client for Amazon Elastic Compute Cloud.
|
Package ec2 provides a client for Amazon Elastic Compute Cloud. |
|
github.com/awslabs/aws-sdk-go/service/elb
Package elb provides a client for Elastic Load Balancing.
|
Package elb provides a client for Elastic Load Balancing. |
|
github.com/boltdb/bolt
Package bolt implements a low-level key/value store in pure Go.
|
Package bolt implements a low-level key/value store in pure Go. |
|
github.com/facebookgo/httpcontrol
Package httpcontrol allows a HTTP transport supporting connection pooling, timeouts & retries.
|
Package httpcontrol allows a HTTP transport supporting connection pooling, timeouts & retries. |
|
github.com/facebookgo/pqueue
Package pqueue provides a priority queue implementation.
|
Package pqueue provides a priority queue implementation. |
|
github.com/garyburd/redigo/redis
Package redis is a client for the Redis database.
|
Package redis is a client for the Redis database. |
|
github.com/golang/groupcache/lru
Package lru implements an LRU cache.
|
Package lru implements an LRU cache. |
|
github.com/golang/groupcache/singleflight
Package singleflight provides a duplicate function call suppression mechanism.
|
Package singleflight provides a duplicate function call suppression mechanism. |
|
github.com/google/go-github/github
Package github provides a client for using the GitHub API.
|
Package github provides a client for using the GitHub API. |
|
github.com/google/go-querystring/query
Package query implements encoding of structs into URL query parameters.
|
Package query implements encoding of structs into URL query parameters. |
|
github.com/gorilla/context
Package context stores values shared during a request lifetime.
|
Package context stores values shared during a request lifetime. |
|
github.com/gorilla/css/scanner
Package gorilla/css/scanner generates tokens for a CSS3 input.
|
Package gorilla/css/scanner generates tokens for a CSS3 input. |
|
github.com/gorilla/mux
Package gorilla/mux implements a request router and dispatcher.
|
Package gorilla/mux implements a request router and dispatcher. |
|
github.com/jmoiron/jsonq
Package jsonq simplify your json usage with a simple hierarchical query.
|
Package jsonq simplify your json usage with a simple hierarchical query. |
|
github.com/jordan-wright/email
Package email is designed to provide an "email interface for humans." Designed to be robust and flexible, the email package aims to make sending email easy without getting in the way.
|
Package email is designed to provide an "email interface for humans." Designed to be robust and flexible, the email package aims to make sending email easy without getting in the way. |
|
github.com/mjibson/snmp
Package snmp provides an implementation of the SNMP specification.
|
Package snmp provides an implementation of the SNMP specification. |
|
github.com/mjibson/snmp/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. |
|
github.com/mjibson/snmp/mib
Package mib parses modules of the virtual management information store.
|
Package mib parses modules of the virtual management information store. |
|
github.com/olivere/elastic
Package elastic provides an interface to the Elasticsearch server (http://www.elasticsearch.org/).
|
Package elastic provides an interface to the Elasticsearch server (http://www.elasticsearch.org/). |
|
github.com/olivere/elastic/uritemplates
Package uritemplates is a level 4 implementation of RFC 6570 (URI Template, http://tools.ietf.org/html/rfc6570).
|
Package uritemplates is a level 4 implementation of RFC 6570 (URI Template, http://tools.ietf.org/html/rfc6570). |
|
github.com/tatsushid/go-fastping
Package fastping is an ICMP ping library inspired by AnyEvent::FastPing Perl module to send ICMP ECHO REQUEST packets quickly.
|
Package fastping is an ICMP ping library inspired by AnyEvent::FastPing Perl module to send ICMP ECHO REQUEST packets quickly. |
|
github.com/vaughan0/go-ini
Package ini provides functions for parsing INI configuration files.
|
Package ini provides functions for parsing INI configuration files. |
|
github.com/vdobler/chart
Package chart implements common chart/plot types.
|
Package chart implements common chart/plot types. |
|
golang.org/x/net/html
Package html implements an HTML5-compliant tokenizer and parser.
|
Package html implements an HTML5-compliant tokenizer and parser. |
|
golang.org/x/net/html/atom
Package atom provides integer codes (also known as atoms) for a fixed set of frequently occurring HTML strings: tag names and attribute keys such as "p" and "id".
|
Package atom provides integer codes (also known as atoms) for a fixed set of frequently occurring HTML strings: tag names and attribute keys such as "p" and "id". |
|
golang.org/x/net/icmp
Package icmp provides basic functions for the manipulation of messages used in the Internet Control Message Protocols, ICMPv4 and ICMPv6.
|
Package icmp provides basic functions for the manipulation of messages used in the Internet Control Message Protocols, ICMPv4 and ICMPv6. |
|
golang.org/x/net/internal/iana
Package iana provides protocol number resources managed by the Internet Assigned Numbers Authority (IANA).
|
Package iana provides protocol number resources managed by the Internet Assigned Numbers Authority (IANA). |
|
golang.org/x/net/ipv4
Package ipv4 implements IP-level socket options for the Internet Protocol version 4.
|
Package ipv4 implements IP-level socket options for the Internet Protocol version 4. |
|
golang.org/x/net/ipv6
Package ipv6 implements IP-level socket options for the Internet Protocol version 6.
|
Package ipv6 implements IP-level socket options for the Internet Protocol version 6. |
|
golang.org/x/sys/windows/registry
Package registry provides access to the Windows registry.
|
Package registry provides access to the Windows registry. |
|
golang.org/x/sys/windows/svc
Package svc provides everything required to build Windows service.
|
Package svc provides everything required to build Windows service. |
|
golang.org/x/sys/windows/svc/debug
Package debug provides facilities to execute svc.Handler on console.
|
Package debug provides facilities to execute svc.Handler on console. |
|
golang.org/x/sys/windows/svc/eventlog
Package eventlog implements access to Windows event log.
|
Package eventlog implements access to Windows event log. |
|
golang.org/x/sys/windows/svc/mgr
Package mgr can be used to manage Windows service programs.
|
Package mgr can be used to manage Windows service programs. |
|
gopkg.in/fsnotify.v1
Package fsnotify provides a platform-independent interface for file system notifications.
|
Package fsnotify provides a platform-independent interface for file system notifications. |
|
gopkg.in/yaml.v1
Package yaml implements YAML support for the Go language.
|
Package yaml implements YAML support for the Go language. |
|
Simple script to build bosun and scollector.
|
Simple script to build bosun and scollector. |
|
docs
command
|
|
|
generate
command
|
|
|
release
command
|
|
|
cmd
|
|
|
backfill
command
Backfill denormalizes historic OpenTSDB data.
|
Backfill denormalizes historic OpenTSDB data. |
|
bosun
command
|
|
|
bosun/conf/parse
Package parse builds parse trees for configurations as defined by conf.
|
Package parse builds parse trees for configurations as defined by conf. |
|
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
command
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. |
|
silence
command
|
|
|
tsdbrelay
command
tsdbrelay relays OpenTSDB traffic to TSD and Bosun servers.
|
tsdbrelay relays OpenTSDB traffic to TSD and Bosun servers. |
|
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 util defines utilities for bosun.
|
Package util defines utilities for bosun. |
|
Package version holds some version data common to bosun and scollector.
|
Package version holds some version data common to bosun and scollector. |
|
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.