traffic-light
Version:
A status traffic light for monitoring your site
81 lines (52 loc) • 2.9 kB
Markdown
# traffic-light
Monitor the status of your websites and applications with traffic-lights!
[](http://travis-ci.org/juliangruber/traffic-light)
```bash
$ traffic-light --port 4000
$ curl -o light.png http://localhost:4000/https%3A%2F%2Fgithub.com%2F
$ open light.png
```
The traffic-light will be
*  when the Server responds with code 200 in time
* , when a timeout is triggered
* , when there is an error or the response code isn't 200
## URL
```
http://traffic-light/ + encodeURIComponent(http://address.to/check)
```
### Parameters
* `?timeout=x` show a __yellow__ light if the server responded ok but took more than `x` milliseconds to answer.
* `?regex=y` show a __red__ light if the server responded ok but the response body doesn't match `y`. Might need to be uri-encoded.
* `?not-regex=z` show a __red__ light if the server responded ok but the response body does match `z`. Might need to be uri-encoded.
## Server
```bash
$ traffic-light --help
Start traffic-light server.
Usage: traffic-light [options]
Options:
--port, -p Port to listen on [default: 4000]
--help Print usage instructions
```
## Library
`traffic-light` exports an express request handler.
```js
var lights = require('traffic-light')
var express = require('express')
var app = express()
app.use('lights', lights)
app.listen(3000)
```
## Installation
As application:
```bash
$ npm install -g traffic-light
```
As library:
```bash
$ npm install traffic-light
```
## License
Copyright (c) 2012 Julian Gruber <julian@juliangruber.com>
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.