Giter Club home page Giter Club logo

hubot-bosun's Introduction

hubot-bosun

Build Status

NPM

Allows Hubot to interact with Bosun.

See src/bosun.coffee for full documentation.

Installation

In the hubot project repo, run:

npm install hubot-bosun --save

Then add hubot-bosun to your external-scripts.json:

[
  "hubot-bosun"
]

Configuration

hubot-bosun may be used with hubot-auth and can be configured via the following environment variables:

  • HUBOT_BOSUN_HOST -- Bosun server URL, e.g., http://localhost:8070
  • HUBOT_BOSUN_LINK_URL -- If set, this URL will be used for links instead of HUBOT_BOSUN_HOST
  • HUBOT_BOSUN_ROLE -- If set, auth role required to interact with Bosun. Default is bosun
  • HUBOT_BOSUN_SLACK -- If yes enables rich text formatting for Slack, default is no
  • HUBOT_BOSUN_LOG_LEVEL -- Log level, default is info
  • HUBOT_BOSUN_TIMEOUT -- Timeout for Bosun API calls in milliseconds; default is 10000
  • HUBOT_BOSUN_RELATIVE_TIME -- If yes all dates and times are presented relative to now, e.g. 2 min ago

Commands

Incidents

  • show open bosun incidents shows all open incidents, unacked and acked, sorted by incident id
  • <ack|close> bosun incident[s] <Id,...> because <message> acks or closes bosun incidents with the specified incident ids

Silences

  • show bosun silences shows all active silences
  • <set|test> bosun silence for <alert|tagkey>=value[,...] for <duration> because <message> sets or tests a new silence, e.g., set bosun silence for alert=test.lukas,host=muffin for 1h because I want to. Can also be used with alert or tags only.
  • clear bosun silence <id> deletes silence with the specific silence id

Events

Please see the event handlers in src/bosun.coffee for the specific event formats.

Accepts the following events

  • bosun.set_silence
  • bosun.clear_silence
  • bosun.check_silence

Emits the following events

  • bosun.result.set_silence.successful
  • bosun.result.set_silence.failed
  • bosun.result.clear_silence.successful
  • bosun.result.clear_silence.failed
  • bosun.result.check_silence.successful
  • bosun.result.check_silence.failed

Sample Interaction

Plain

Lukas Pustina> list open bosun incidents

hubot> @lukas.pustina: Retrieving Bosun incidents ...

hubot> @lukas.pustina: Yippie. Done.
 So, there are currently 2 open incidents in Bosun.
 4: critical: <no value> on muffin
 Acked and active since 2 hours with {host=muffin}.
 lukas.pustina acknowledged this incident at a few seconds ago.
 5: warning: <no value> on cake
 Acked and active since 3 hours with {host=cake}.
 lukas.pustina acknowledged this incident at a few seconds ago.

Lukas Pustina> close bosun incidents 4,5 because Everything is fine again.

hubot> @lukas.pustina: Trying to close Bosun incidents 4,5 ...

hubut> @lukas.pustina: Yippie. Done.

Lukas Pustina> list open bosun incidents

hubot> @lukas.pustina: Retrieving Bosun incidents ...

hubot> @lukas.pustina: Yippie. Done.
 Oh, no incidents there. Everything is ok.

Slack

Slack interaction

NPM Module

https://www.npmjs.com/package/hubot-bosun

hubot-bosun's People

Contributors

lukaspustina avatar dschneller avatar

Watchers

 avatar James Cloos avatar

Forkers

dschneller

hubot-bosun's Issues

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.