Git Product home page Git Product logo

techstar-uptime's Introduction

Node uptime bot

Uptime monitor in Node.js that posts status changes to Slack

NPM

Installation

npm install techstar-uptime --save

Usage

Create the websites.js file and specify some services we wish to monitor.

module.exports = [
  {
    url: 'https://www.google.com', // URL of service we'll be pining
    timeout: 200 // threshold in milliseconds above which is considered degraded performance
  },{
    url: 'https://www.github.com',
    timeout: 200 
  },
]
const website = require('./websites'),
      Uptime  = require('techstar-uptime');
      
const uptime = new Uptime({
  SLACK_WEBHOOK_URL: 'SLACK_WEBHOOK_URL'
});
uptime.monitor(website);

app.use('/uptime', uptime);

Setting up Slack

Head on over to the Incoming WebHooks Slack app. If you're signed in to your Slack Workspace you should see an Add Configuration button. Hit it!

screenshot

Select or create a new channel then hit the Add Incoming WebHooks integration screenshot

Grab the WebHook URL and paste it into the SLACK_WEBHOOK_URL, which would look like so: SLACK_WEBHOOK_URL=https://hooks.slack.com/services/XXXXXX/YYYYYY/XXXXXXXXXXXX screenshot

You can update websites.js with the services you wish to monitor and throw the code up on a server. screenshot

Contributors

You may contribute in several ways like creating new features, fixing bugs, improving documentation and examples or translating any document here to your language. Find more information in CONTRIBUTING.md. Contributors

License

Techstar uptime is open-sourced software licensed under the MIT license.

techstar-uptime's People

Contributors

tortuvshin 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.