Giter Site home page Giter Site logo

nclr / health-check-slack Goto Github PK

View Code? Open in Web Editor NEW
2.0 1.0 1.0 13 KB

Simple Node app to do health checks and send notifications to a slack channel

License: BSD 2-Clause "Simplified" License

JavaScript 100.00%
node slack health-check url link slack-channels notifications periodically

health-check-slack's Introduction

health-check-slack ๐Ÿค–

Simple Node app to do health checks on 1 or more urls and send notifications to a slack channel

Install ๐ŸŒŸ๐Ÿ“ฆ

git clone https://github.com/nclr/health-check-slack.git
cd health-check-slack
npm install

Usage โœจ๐Ÿš€

Simply edit config.json and add the urls to check along with the desired interval (in milliseconds) for each loop like the example below:

{
    "urls": {
        "rest service": {
            "url": "https://example.com/app/to/check",
            "interval": "20000"
        },
        "Website": {
            "url": "https://example.com",
            "interval": "3000"
        }
    }
}

Then set up an Incoming Webhook to one of your slack channels and you're good to go! ๐Ÿ˜‰

Error Handling

When a 404 status code incurs it sends "LinkName is not reachable!" and when the error with the specified link is resolved (and a 200 status code is returned) it automatically responds with "LinkName is reachable again!". Every "fail" notification requires at least two failed attempts in a row to reach the desired URL. This minimizes the possibility of some temporary connection problem on the health-check server masqueraded as a URL problem.

health-check-slack's People

Contributors

nclr avatar

Stargazers

 avatar  avatar

Watchers

 avatar

Forkers

profusion

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.