Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
jeffsu committed Sep 11, 2012
1 parent fd9f899 commit 6d217eb
Showing 1 changed file with 40 additions and 0 deletions.
40 changes: 40 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,3 +48,43 @@ services:
host: google.com
port: 80
```
### Services
Services are a way of grouping several sensor checks together. In the example above, we have a "google" service w
hich we check by making a get request to "https://www.google.com" and also seeing if we have a connection to port 8
0 on the "google.com" host. In the yaml config, a service is a "hash" of sensors where the keys are the names of
the sensors and the values are the configuration.
### Sensors
Sensors are a way of describing a health check. Each sensor config MUST at least have a strategy. Common configuration
options accross all strategies are:
* timeout: number (milliseconds) to define how long it will allow a check before declaring it a failure
* interval: number (milliseconds) of time to wait between health checks (called after the result of a check)
* fall: number of fails to be considered down
* rise: number of passes to be considered up
Here are some
examples of how you can use sensors and their strategies:
*tcp*
```yaml
strategy: tcp
host: google.com
port: 80
```
*http*
```yaml
strategy: http
url: https://www.google.com
```
*pidfile*
```yaml
strategy: pidfile
pidfile: /var/pids/mysql.pid
```

0 comments on commit 6d217eb

Please sign in to comment.