Git Product home page Git Product logo

sermon's Introduction

Sermon

Sermon is simple server monitoring script with email and slack notifications.

Usage

In order to use Sermon, you need to place configuration file in your $HOME directory. File should be called .sermon.yml and it can be generated automatically using following command:

$ sermon --setup

Attributes which can be defined in configuration file are following:

  • ping - gets list of addresses to ping in order to check connection.
  • free_space - gets collection of key/value entries. Keys are directories path and values expresses maximum value of space (in MB).
  • free_mem - gets maximal memory usage (in MB).
  • emails - gets list of emails. When one or more checks fail, notifications will be send on those email addresses.
  • slack - gets webhook_url and channel to which notification will be send. webhook_url parameter is required, while channel is optional.

How does it work?

In simple steps, sermon performs following actions:

  1. Reads configuration file.
  2. Performs some basic validations (e.g. at least one communication channel - slack or email - must be defined).
  3. If validation is successful - creates notifying and measuring objects and places them in specific registers.
  4. Loads notifying and measuring objects from registry.
  5. Performs checks and collects errors.
  6. Sends notifications if any error was found.

Notification

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/musztardem/sermon.

License

The gem is available as open source under the terms of the MIT License.

sermon's People

Contributors

musztardem avatar

Watchers

 avatar

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.