bennetgallein/cachet-monitor
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

readme: add build info

Browse Source
This commit is contained in:
Christoph Eck
2020-01-27 18:48:06 +01:00
parent 1c44776138
commit 7e5187764b
1 changed files with 14 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

18
readme.md
View File

@@ -23,6 +23,7 @@ api:
insecure: false insecure: false
# https://golang.org/src/time/format.go#L57 # https://golang.org/src/time/format.go#L57
date_format: 02/01/2006 15:04:05 MST date_format: 02/01/2006 15:04:05 MST
slack_webhook: https://hooks.slack.com/services/T00000000/B00000000/XXXXXXXXXXXXXXXXXXXXXXXX
monitors: monitors:
# http monitor example # http monitor example
- name: google - name: google
@@ -32,7 +33,7 @@ monitors:
strict: true strict: true
# HTTP method # HTTP method
method: POST method: POST
# set to update component (either component_id or metric_id are required) # set to update component (either component_id or metric_id are required)
component_id: 1 component_id: 1
# set to post lag to cachet metric (graph) # set to post lag to cachet metric (graph)
@@ -46,7 +47,7 @@ monitors:
message: "{{ .Monitor.Name }} check **failed** (server time: {{ .now }})\n\n{{ .FailReason }}" message: "{{ .Monitor.Name }} check **failed** (server time: {{ .now }})\n\n{{ .FailReason }}"
fixed: fixed:
subject: "I HAVE BEEN FIXED" subject: "I HAVE BEEN FIXED"
# seconds between checks # seconds between checks
interval: 1 interval: 1
# seconds for timeout # seconds for timeout
@@ -112,7 +113,7 @@ Options:
--version Show version --version Show version
--immediate Tick immediately (by default waits for first defined interval) --immediate Tick immediately (by default waits for first defined interval)
--restarted Get open incidents before start monitoring (if monitor died or restarted) --restarted Get open incidents before start monitoring (if monitor died or restarted)
Environment varaibles: Environment varaibles:
CACHET_API override API url from configuration CACHET_API override API url from configuration
CACHET_TOKEN override API token from configuration CACHET_TOKEN override API token from configuration
@@ -135,7 +136,7 @@ The following variables are available:
| Root objects | Description | | Root objects | Description |
| ------------- | ------------------------------------| | ------------- | ------------------------------------|
| `.SystemName` | system name | | `.SystemName` | system name |
| `.API` | `api` object from configuration | | `.API` | `api` object from configuration |
| `.Monitor` | `monitor` object from configuration | | `.Monitor` | `monitor` object from configuration |
| `.now` | formatted date string | | `.now` | formatted date string |
@@ -172,3 +173,12 @@ We'll happily accept contributions for the following (non exhaustive list).
- Implement TCP check - Implement TCP check
- Any bug fixes / code improvements - Any bug fixes / code improvements
- Test cases - Test cases
# Build on MacOS
1. Read and install with https://ahmadawais.com/install-go-lang-on-macos-with-homebrew/
2. Test in console with `go get -u` and `go build cli/main.go`
3. Run `./go-executable-build.sh cli/main.go`
4. `mv cli/main.go-linux-amd64 cachet-monitor-linux-amd64`