Giter VIP home page Giter VIP logo

alertme's Introduction

alertme

Service and Server Monitoring app - Will send an email alert if somethings goes wrong

How to get going :

  1. Install Node.js for your operating system.
  2. Create a folder for tingoDB in local system.
  3. Get a copy of code - https://github.com/bbytes/alertme.git to your local directory.
  4. Run the command - npm install -d - in Node command prompt after changing to your cloned directory. This should install the dependencies currently added in package.json file.
  5. Set path of your tingoDB folder to dbPath property in config/config.js.
  6. Set hostname and port on which you want to run your alertme in config/config.js.
  7. User credentials for the application in config.js file.

Running the application :

  1. From the command prompt run - node app.js . You should be able to see a Login page at http://localhost:3333/alertme.
  2. Login with Admin user credentials : Username : admin, Password : admin
  3. Add hosts to alertme and enable monitoring.
  4. Now you will able see the status and number of outages etc.

Configuring the server

dbPath : 'C:/tingoDB/data',
app : {
	name : 'alertme',
	hostname : 'localhost',
	port : 3333
},
credentials : {
	username : "admin",
	password : "admin"
},
mail : {
	apiKey : 'key-xxxxxxt26ij',
	from : '[email protected]',
	subject : 'AlertMe'
}

Features

Configure via REST

Routes can be added or removed or updated using rest.

  • Adding host
    • method : POST,
    • url : /routes/save,
    • example route json : {"host" : "", "port" : "", "config" : {"enabled" : "false", "ping service" : "", "timeout" : "", "ping interval" : "", "alert to" : "", "warning if takes more than" : "", "method" : "", "url" : "", "expectedStatuscode" : "", "expectedData" : ""}, "state" : {}}
  • Update host
    • method : POST
    • url : /hosts/update
    • data : hosts json to be updated
  • Delete host
    • method : POST
    • url : /hosts/deleteHost
    • data : {"id" : "7"}
  • Get all hosts
    • method : GET,
    • url : /hosts/allHosts

UI for adding and viewing status of servers or services

alertme's People

Watchers

James Cloos avatar Thanneer 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.