bosun.org@v0.0.0-20210513094433-e25bc3e69a1f/docs/resources.md (about)

     1  ---
     2  layout: default
     3  title: Resources
     4  ---
     5     
     6  
     7  ## Getting Started
     8  
     9  ### [Installing Bosun for Production](https://medvedev.io/blog/posts/2015-06-21-bosun-install-1.html "Installing Bosun for production") by Dima Medvedev
    10  > A detailed walk-through of installing Bosun and OpenTSDB using Apache Ambari to setup HBase/Hadoop. See also [these snippets](https://gist.github.com/gbrayut/3af4bcd0458d2aa57dd2) for using Cloudera CDH 5.4.4 on RHEL 6.
    11  
    12  ### [Stack Overflow's Bosun Architecture](http://kbrandt.com/post/bosun_arch/)
    13  > Reference setup of Bosun in a production environment.
    14  
    15  ### [Bosun Fundamentals](https://www.youtube.com/playlist?list=PLWetmRzVkFTdnjRmE-a-JRx2m8qgB6iu9) video playlist by Kyle Brandt
    16  > An introduction to the data model of Bosun’s primary time series backend OpenTSDB. The [first video](https://www.youtube.com/watch?v=DVavDN8tyIc&list=PLWetmRzVkFTdnjRmE-a-JRx2m8qgB6iu9&index=1) covers time series, metrics and tags, aggregation, rate calculation, and downsampling. The [second video](https://www.youtube.com/watch?v=7NYHOp3HlQc&list=PLWetmRzVkFTdnjRmE-a-JRx2m8qgB6iu9&index=2) covers data types, functions, operators, and set joins.
    17  
    18  ### Docker images
    19  > There is a [full Bosun](https://hub.docker.com/r/stackexchange/bosun/) image that can be used for testing
    20  > (Not recommended for production use), and an [OpenTSDB only](https://hub.docker.com/r/petergrace/opentsdb-docker/) 
    21  > image if desired. Newer versions than the published ones can be built with the `docker-compose.yml` file in the 
    22  > `docker` directory of the repository.
    23  
    24  ### Chef Cookbooks by ptqa
    25  > There is a cookbook for using Chef to deploy [scollector](https://supermarket.chef.io/cookbooks/scollector) and another work in progress for deploying [Bosun](https://github.com/ptqa/chef-bosun).
    26  
    27  ### Slack Chat Room and Questions on Stack Overflow and Server Fault
    28  > If you have questions you can get an invite to [https://bosun.slack.com/](http://bosun.org/slackInvite) or use the Bosun tag on [Stack Overflow](http://stackoverflow.com/questions/tagged/bosun) or [Server Fault](http://serverfault.com/questions/tagged/bosun).
    29  
    30     
    31  
    32  ## Presentations
    33  
    34  ### [Monitorama 2015 (PDX)](https://vimeo.com/131581326) by Kyle Brandt
    35  > This presentation has screencasts of building an alert starting about 15 minutes in. The first 15 minutes explain some of the design principles behind Bosun. After the first screen cast of building an alert there are also some example alerts.
    36  
    37  ### An overview of creating [Scollector](http://bit.ly/2015AUG04) and [Bosun](http://go-talks.appspot.com/github.com/captncraig/presentations/bosun/bosun.slide#1) by Craig Peterson and Greg Bray
    38  > Presentation give to the Utah Gophers meetup about creating a monitoring and alerting system in Go.
    39  
    40  ### [LISA 2014](https://www.usenix.org/conference/lisa14/conference-program/presentation/brandt) by Kyle Brandt
    41  > This was the first presentation on Bosun which was given right after the initial release. A great introduction to the underlying thoughts on problems with alerting and how Bosun solves them.
    42  
    43     
    44  
    45  ## Libraries and Collectors
    46  
    47  ### [BosunReporter.NET](https://github.com/bretcope/BosunReporter.NET) by Bret Copeland
    48  > A .NET client to send metrics to Bosun/OpenTSDB. It is designed to encourage best-practices while making it easy to create counters and gauges, including multi-aggregate gauges.
    49  
    50  ### [Bosun collect package](http://godoc.org/bosun.org/collect)
    51  > A Go package used by Bosun, scollector, and [various other applications](http://godoc.org/bosun.org/collect?importers) to send metrics to Bosun/OpenTSDB. Includes limited support for multi-aggregate gauges.
    52  
    53  ### [httpUnit](http://godoc.org/github.com/StackExchange/httpunit)
    54  > A Go package and command line tool used by scollector to send HTTP, HTTPS, and TCP test results to Bosun.
    55  
    56  ### [bosun-jmx](https://github.com/PeterGrace/bosun-jmx) by Peter Grace
    57  > A external collector that relays JMX metrics to Bosun/OpenTSDB via scollector. Also a good starting point for a custom Java collector.
    58  
    59  ### [go-metrics-bosun](https://bitbucket.org/oneoffcode/go-metrics-bosun/src) by Richard Bucker
    60  > A Bosun port for the [go-metrics](https://github.com/rcrowley/go-metrics) library based on Coda Hale's [Metrics](https://github.com/dropwizard/metrics) library.
    61  
    62  ### [vertx-bosun](https://github.com/cyngn/vertx-bosun) by Jeremy Truelove
    63  > Sends metrics from [Vert.x](http://vertx.io/) applications to Bosun.
    64  
    65  ### [ekg-bosun](https://hackage.haskell.org/package/ekg-bosun)
    66  > Send [ekg](https://github.com/tibbe/ekg) metrics from Haskell applications to Bosun.
    67  
    68  ### [bosun_emitter](https://github.com/lukaspustina/bosun_emitter) by Lukas Pustina
    69  > bosun_emitter is a Rust library and CLI standalone binary called `emit_bosun` that may be used on the command line or from any shell script to send a single metric datum to Bosun.
    70  
    71  ### [opsgenie-bosun](https://github.com/TrentScholl/opsgenie-bosun)
    72  > OpsGenie Marid integration for Bosun.
    73  
    74  ### [rs-collector](https://github.com/lukaspustina/rs-collector) by Lukas Pustina
    75  > rs-collector is a Rust based, scollector compatible telemetry collector for services currently not covered by scollector. It collects selected metrics for Galera, JVM, MongoDB, Postfix etc.
    76  
    77  _See also the list of built-in collectors included with [scollector](http://bosun.org/scollector/)_
    78  
    79     
    80  
    81  ## Tools
    82  
    83  ### [hubot-bosun](https://github.com/lukaspustina/hubot-bosun) by Lukas Pustina
    84  > Bosun integration for [Hubot](https://hubot.github.com) allowing to ack and close incidents as well as to create and clear silences with optional prettified Slack output.
    85  
    86  ### [discreet-scollector](https://forge.puppet.com/discreet/scollector) by Chris Pisano
    87  > Puppet module for installing and configuring the SCollector agent.
    88  
    89  ### [VS Code Plugin](https://marketplace.visualstudio.com/items?itemName=tbutterwith.bosun) by Tom Butterwith
    90  > Syntax highlighting, openTSDB metric path completion and config validate extension for [VS Code](https://code.visualstudio.com/).
    91  
    92  ### [iOS Widget for Bosun Alarms](https://github.com/lukaspustina/bosun_scriptable_widget) by Lukas Pustina
    93  > This is a quick and dirty JavaScript snippet for the iOS app Scriptable allowing to create a Bosun Alarms overview widget for iOS 14+.
    94  
    95     
    96  
    97  ## [Screenshots and other Media](/media)