-Cachet Monitor plugin
- -This is a monitoring plugin for CachetHQ.
- -
+
-
diff --git a/javascripts/main.js b/javascripts/main.js
new file mode 100644
index 0000000..d8135d3
--- /dev/null
+++ b/javascripts/main.js
@@ -0,0 +1 @@
+console.log('This would be the main JS file.');
diff --git a/params.json b/params.json
index c7fc405..d7450d7 100644
--- a/params.json
+++ b/params.json
@@ -1 +1,7 @@
-{"name":"Cachet-monitor","tagline":"Monitors a URL and posts data points to cachet","body":"Cachet Monitor plugin\r\n=====================\r\n\r\nThis is a monitoring plugin for CachetHQ.\r\n\r\n\r\n\r\nFeatures\r\n--------\r\n\r\n- [x] Creates & Resolves Incidents\r\n- [x] Posts monitor lag every second\r\n- [x] Updates Component to Partial Outage\r\n- [x] Updates Component to Major Outage if in Partial Outage\r\n- [x] Can be run on multiple servers and geo regions\r\n\r\nDocker Quickstart\r\n-----------------\r\n\r\n1. Create a configuration json\r\n2. \r\n```\r\ndocker run -d \\\r\n --name cachet-monitor \\\r\n -h cachet-monitor \\\r\n -v `pwd`/config.json:/etc/cachet-monitor.config.json \\\r\n castawaylabs/cachet-monitor\r\n```\r\n\r\nConfiguration\r\n-------------\r\n\r\n```\r\n{\r\n \"api_url\": \"https://demo.cachethq.io/api\",\r\n \"api_token\": \"9yMHsdioQosnyVK4iCVR\",\r\n \"monitors\": [\r\n {\r\n \"name\": \"nodegear frontend\",\r\n \"url\": \"https://nodegear.io/ping\",\r\n \"metric_id\": 0,\r\n \"component_id\": 0,\r\n \"threshold\": 80,\r\n \"component_id\": null,\r\n \"expected_status_code\": 200,\r\n \"strict_tls\": true\r\n }\r\n ],\r\n \"insecure_api\": false\r\n}\r\n```\r\n\r\n*Notes:*\r\n\r\n- `metric_id` is optional\r\n- `insecure_api` if true it will ignore HTTPS certificate errors (eg if self-signed)\r\n- `strict_tls` if false (true is default) it will ignore HTTPS certificate errors (eg if monitor uses self-signed certificate)\r\n- `component_id` is optional\r\n- `threshold` is a percentage\r\n- `expected_status_code` is a http response code\r\n- GET request will be performed on the `url`\r\n\r\nHow to run\r\n----------\r\n\r\nExample:\r\n\r\n1. Set up [Go](https://golang.org)\r\n2. `go install github.com/castawaylabs/cachet-monitor`\r\n3. `cachet-monitor -c https://raw.githubusercontent.com/CastawayLabs/cachet-monitor/master/example.config.json`\r\n\r\nProduction:\r\n\r\n1. Download the example config and save to `/etc/cachet-monitor.config.json`\r\n2. Run in background: `nohup cachet-monitor 2>&1 > /var/log/cachet-monitor.log &`\r\n\r\n```\r\nUsage of cachet-monitor:\r\n -c=\"/etc/cachet-monitor.config.json\": Config path\r\n -log=\"\": Log path\r\n -name=\"\": System Name\r\n```\r\n\r\nEnvironment variables\r\n---------------------\r\n\r\n| Name | Example Value | Description |\r\n| ------------ | --------------------------- | --------------------------- |\r\n| CACHET_API | http://demo.cachethq.io/api | URL endpoint for cachet api |\r\n| CACHET_TOKEN | randomvalue | API Authentication token |","google":"","note":"Don't delete this file! It's used internally to help with page regeneration."}
\ No newline at end of file
+{
+ "name": "Cachet-monitor",
+ "tagline": "Distributed monitoring plugin for CachetHQ",
+ "body": "\r\n\r\nFeatures\r\n--------\r\n\r\n- [x] Creates & Resolves Incidents\r\n- [x] Posts monitor lag to cachet graphs\r\n- [x] Updates Component to Partial Outage\r\n- [x] Updates Component to Major Outage if already in Partial Outage (works well with distributed monitoring)\r\n- [x] Can be run on multiple servers and geo regions\r\n\r\nConfiguration\r\n-------------\r\n\r\n```\r\n{\r\n // URL for the API. Note: Must end with /api/v1\r\n \"api_url\": \"https://
+
+
@@ -134,26 +113,55 @@
-
+
+
+
-Features
+Features- [x] Creates & Resolves Incidents -
- [x] Posts monitor lag every second +
- [x] Posts monitor lag to cachet graphs
- [x] Updates Component to Partial Outage -
- [x] Updates Component to Major Outage if in Partial Outage +
- [x] Updates Component to Major Outage if already in Partial Outage (works well with distributed monitoring)
- [x] Can be run on multiple servers and geo regions
-Docker Quickstart
- --
-
- Create a configuration json -
- -
docker run -d \
- --name cachet-monitor \
- -h cachet-monitor \
- -v `pwd`/config.json:/etc/cachet-monitor.config.json \
- castawaylabs/cachet-monitor
--Configuration
+Configuration{
- "api_url": "https://demo.cachethq.io/api",
- "api_token": "9yMHsdioQosnyVK4iCVR",
- "monitors": [
- {
- "name": "nodegear frontend",
- "url": "https://nodegear.io/ping",
- "metric_id": 0,
- "component_id": 0,
- "threshold": 80,
- "component_id": null,
- "expected_status_code": 200,
- "strict_tls": true
- }
- ],
- "insecure_api": false
+ // URL for the API. Note: Must end with /api/v1
+ "api_url": "https://<cachet domain>/api/v1",
+ // Your API token for Cachet
+ "api_token": "<cachet api token>",
+ // optional, false default, set if your certificate is self-signed/untrusted
+ "insecure_api": false,
+ "monitors": [{
+ // required, friendly name for your monitor
+ "name": "Name of your monitor",
+ // required, url to probe
+ "url": "Ping URL",
+ // optional, http method (defaults GET)
+ "method": "get",
+ // self-signed ssl certificate
+ "strict_tls": true,
+ // seconds between checks
+ "interval": 10,
+ // post lag to cachet metric (graph)
+ // note either metric ID or component ID are required
+ "metric_id": <metric id>,
+ // post incidents to this component
+ "component_id": <component id>,
+ // If % of downtime is over this threshold, open an incident
+ "threshold": 80,
+ // optional, expected status code (either status code or body must be supplied)
+ "expected_status_code": 200,
+ // optional, regular expression to match body content
+ "expected_body": "P.*NG"
+ }],
+ // optional, system name to identify bot (uses hostname by default)
+ "system_name": "",
+ // optional, defaults to stdout
+ "log_path": ""
}
Notes:
- --
-
-
-
metric_idis optional
- -
-
insecure_apiif true it will ignore HTTPS certificate errors (eg if self-signed)
- -
-
strict_tlsif false (true is default) it will ignore HTTPS certificate errors (eg if monitor uses self-signed certificate)
- -
-
component_idis optional
- -
-
thresholdis a percentage
- -
-
expected_status_codeis a http response code
- - GET request will be performed on the
url-
-
-How to run
- -Example:
+Installation-
-
- Set up Go +
- Download binary from release page -
go install github.com/castawaylabs/cachet-monitor
-cachet-monitor -c https://raw.githubusercontent.com/CastawayLabs/cachet-monitor/master/example.config.json
+- Create your configuration (example) +
cachet-monitor -c /etc/cachet-monitor.config.json
Production:
- --
-
- Download the example config and save to
/etc/cachet-monitor.config.json-
- - Run in background:
nohup cachet-monitor 2>&1 > /var/log/cachet-monitor.log &-
-
pro tip: run in background using nohup cachet-monitor 2>&1 > /var/log/cachet-monitor.log &
Usage of cachet-monitor:
-c="/etc/cachet-monitor.config.json": Config path
@@ -121,7 +100,7 @@
-Environment variables
+Environment variables| CACHET_API | -http://demo.cachethq.io/api | +http://demo.cachethq.io/api/v1 | URL endpoint for cachet api |
| CACHET_TOKEN | -randomvalue | +APIToken123 | API Authentication token |
| CACHET_DEV | +1 | +Strips logging | +
We made this tool because we felt the need to have our own monitoring software (leveraging on Cachet). +The idea is a stateless program which collects data and pushes it to a central cachet instance.
-This gives us power to have an army of geographically distributed loggers and reveal issues in both latency & downtime on client websites.
+ ++Package usage
+ +When using cachet-monitor as a package in another program, you should follow what cli/main.go does. It is important to call ValidateConfiguration on CachetMonitor and all the monitors inside.