README.md

StatusOK

Monitor your Website and APIs from your computer.Get notified through Slack or E-mail when your server is down or response time is more than expected.

Simple Version

Simple Setup to monitor your website and recieve a notification to your Gmail when your website is down.

Step 1: Write a config.json with the url information

{
	"notifications":{
		"mail":{
			"smtpHost":"smtp.gmail.com",
			"port":587,
			"username":"yourmailid@gmail.com",
			"password":"your gmail password",
			"from":"yourmailid@gmail.com",
			"to":"destemailid@gmail.com"
		}
	},
	"requests":[
		{
			"url":"http://mywebsite.com",
			"requestType":"GET",
			"checkEvery":30,	
			"responseTime":800
		}
	]
}

Turn on access for your gmail https://www.google.com/settings/security/lesssecureapps .

Step 2: Download bin file from here and run the below command from your terminal

$ ./statusok --config config.json

Thats it !!!! You will receive a mail when your website is down or response time is more.

To run as background process add & at the end

$ ./statusok --config config.json &	

to stop the process

$ jobs
$ kill %jobnumber

Complete Version using InfluxDb

You can save data to influx db and view response times over a period of time as above using graphana.

Guide to install influxdb and grafana

With StatusOk you can monitor all your REST APIs by adding api details to config file as below.A Notification will be triggered when you api is down or response time is more than expected.

{
	"url":"http://mywebsite.com/v1/data",
	"requestType":"POST",
	"headers":{
		"Authorization":"Bearer ac2168444f4de69c27d6384ea2ccf61a49669be5a2fb037ccc1f",
		"Content-Type":"application/json"
	},
	"formParams":{
		"description":"sanath test",
		"url":"http://google.com"
	},
	"checkEvery":30,
	"responseCode":200,		
	"responseTime":800
},

{
	"url":"http://mywebsite.com/v1/data",
	"requestType":"GET",
	"headers":{
		"Authorization":"Bearer ac2168444f4de69c27d6384ea2ccf61a49669be5a2fb037ccc1f",		
	},
	"urlParams":{
		"name":"statusok"
	},
	"checkEvery":300,
	"responseCode":200,		
	"responseTime":800
},

{
	"url":"http://something.com/v1/data",
	"requestType":"DELETE",
	"formParams":{
		"name":"statusok"
	},
	"checkEvery":300,
	"responseCode":200,		
	"responseTime":800
}

Guide to write config.json file

Sample config.json file

To run the app

$ ./statusok --config config.json &

Database

Save Requests response time information and error information to your database by adding database details to config file. Currently only Influxdb 0.9.3+ is supported.

You can also add data to your own database.view details

Notifications

Notifications will be triggered when mean response time is below given response time for a request or when an error is occured . Currently the below clients are supported to receive notifications.For more information on setup click here

1. Slack
2. Smtp Email
3. Mailgun
4. Http EndPoint
5. Dingding

Adding support to other clients is simple.view details

Running with plain Docker

docker run -d -v /path/to/config/folder:/config sanathp/statusok

Note: Config folder should contain config file with name config.json

Running with Docker Compose

Prepare docker-compose.yml config like this:

version: '2'
services:
  statusok:
    build: sanathp/statusok
    volumes:
      - /path/to/config/folder:/config
    depends_on:
      - influxdb
  influxdb:
    image: tutum/influxdb:0.9
    environment:
      - PRE_CREATE_DB="statusok" 
    ports:
      - 8083:8083 
      - 8086:8086
  grafana:
    image: grafana/grafana
    ports:
      - 3000:3000

Now run it:

docker-compose up

Contribution

Contributions are welcomed and greatly appreciated. Create an issue if you find bugs. Send a pull request if you have written a new feature or fixed an issue .Please make sure to write test cases.

License

Copyright 2015 Sanath Kumar Pasumarthy

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License