Giter VIP home page Giter VIP logo

waker's Introduction

Waker

Alert Escalation System

Overview

Tutorial

1. (Optional) Configure auth provider

You can use external auth provider optionally. Currently, Google Auth is only supported (Patches are welcome :) )

$ echo 'GOOGLE_CLIENT_ID=...' >> .env
$ echo 'GOOGLE_CLIENT_SECRET=...' >> .env
$ echo 'GOOGLE_DOMAIN=...' >> .env # If you restrict to use Google Apps domain

2. Start the server

$ bundle install
$ foreman start

It starts an application server and a Sidekiq worker.

3. (If you uses auth provider) Log in

Visit http://localhost:3000 and log in with your credentials. A new user account is automatically created and suspended by default. You can activate a user from http://localhost:3000/users but you have to activate it from rails console because you are the first user:

$ bundle exec rails c
> User.first.update!(active: true)

4. Create users

Visit http://localhost:3000/users/new and create new users.

5. Create a notifier provider

Visit http://localhost:3000/notifier_providers/new and create a notifier provider. See Notifier Providers section for detailed information.

6. Create a notifier

Visit http://localhost:3000/notifiers/new and create a notifier. See Notifier section for detailed information.

7. Create an escalation series

Visit http://localhost:3000/escalation_series/new and create a escalation series. Escalation series is a series of escalations.

8. Create escalations

Visit http://localhost:3000/escalations/new and create escalations.

  • Escalate to: Who gets escalated incidents
  • Escalate after sec: Seconds to escalate incidents since the incidents created

9. Create a topic

Visit http://localhost:3000/topics/new and create topics.

10. Send alerts to the topic

Suppoted alerts generaters are below:

  • Mailgun ( http://localhost:3000/topics/1/mailgun )
  • Mackerel ( http://localhost:3000/topics/1/mackerel )
  • Alertmanager ( http://localhost:3000/topics/1/alertmanager )

If you want to use Mailgun, you can configure Mailgun route setting with Mailgun endpoint you can see in http://localhost:3000/topics/1/mailgun

Configuration

Notifier Providers

HipChat

  • api_token
  • api_version: v1 or v2

Twilio

  • account_sid
  • auth_token
  • from: Phone number

Mailgun

  • api_key
  • from: Email address

Notifiers

Common fields

These are supported by all notifier provider

or_conditions:
- japanese_weekday: true
  not_between: 9:30+0900-18:30+0900
- not_japanese_weekday: true

HipChat

  • room: Room name or ID

Twilio

  • to: Phone number

Mailgun

  • to: Email address

waker's People

Contributors

ryotarai avatar uu4k avatar eagletmt avatar sorah avatar

Stargazers

Takashi Inaba avatar

Watchers

James Cloos avatar  avatar

Forkers

rotoni

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.