57 Commits

Author SHA1 Message Date
f7f35a2028 ent 2023-04-28 17:13:28 +02:00
5ab1c1c9d4 fix: readme 2023-04-28 17:12:45 +02:00
10edc210b2 fixup! feat: update 2023-04-28 17:12:25 +02:00
beca1c0aaa feat: update 2023-04-28 17:08:59 +02:00
8bbe60a8b0 fixup! chore: update readme 2023-04-28 17:06:50 +02:00
7974d0f3fd chore: update readme 2023-04-28 17:06:08 +02:00
2130b3b3dd feat: add icmp support 2023-04-27 22:51:56 +02:00
Christoph Eck
e8dc6e5789 chore(readme): data, expected_md5sum and expected_length 2020-10-20 13:49:14 +02:00
Christoph Eck
5d78504138 Merge branch 'feature/json_data'
- support md5 sum check
- support body length check
- support data post transmit
2020-10-20 12:20:54 +02:00
Christoph Eck
896c0d28da refactor: remove logs and reformat 2020-10-20 12:17:11 +02:00
Ubuntu
7657f99ac9 feat: check content length 2020-10-20 10:12:58 +00:00
Ubuntu
6e0816c077 feat: check md5 sum 2020-10-20 10:02:12 +00:00
Ubuntu
f6ca8816e7 feat: data request with more log outputs 2020-10-20 09:08:39 +00:00
Christoph Eck
dc0170a4c8 feat: http json data 2020-10-20 07:50:31 +02:00
Christoph Eck
e07b2fb574 chore: update go packages 2020-10-20 07:49:30 +02:00
Christoph Eck
cb857b6d10 fix: update readme 2020-03-27 20:19:06 +01:00
Christoph Eck
efb6de4c4c chore: update go libs 2020-03-27 20:12:45 +01:00
Thomas Verchow
c3d22a40db tcp from Soontao/cachet-monitor
# Conflicts:
#	.gitignore
#	cli/main.go
2020-03-27 20:07:49 +01:00
Christoph Eck
7e5187764b readme: add build info 2020-01-27 18:48:06 +01:00
Christoph Eck
1c44776138 Merge branch 'custom' 2020-01-27 18:38:55 +01:00
Christoph Eck
d33688d189 build: add go-exectuable-build.sh 2020-01-27 18:38:33 +01:00
Christoph Eck
29b2bf457a fix: update libraries 2020-01-27 18:37:17 +01:00
Christoph Eck
de4d2451d5 chore(missing): add start argument restarted 2020-01-27 18:36:54 +01:00
Christoph Eck
79676357f3 slack: webhookurl and sendSlack
- GetComponentStatus fix
- get main url from api definition for slack post
- fix run send slack
2020-01-27 18:36:25 +01:00
Christoph Eck
2963a9f610 Merge branch 'feat/slack' into custom
# Conflicts:
#	cli/main.go
2020-01-27 16:15:33 +01:00
Alexander Trost
c186e4b292 fixed sirupsen logrus pkg
switched to go mods

Signed-off-by: Alexander Trost <galexrt@googlemail.com>
2020-01-08 23:54:38 +01:00
Alexander Trost
3f82108f98 added some built binary names to the gitignore
Signed-off-by: Alexander Trost <galexrt@googlemail.com>
2020-01-08 17:49:31 +01:00
A. Feldmann
33bb722e06 go fmt 2020-01-08 17:48:04 +01:00
Alexander Trost
3c343fb0a2 incident: fixed json struct tag
Signed-off-by: Alexander Trost <galexrt@googlemail.com>
2020-01-08 17:45:12 +01:00
Mac Chiang
f9f5c278ec add test 2019-12-18 12:35:44 +08:00
Mac Chiang
43510e18e2 Add slack 2019-12-18 11:54:43 +08:00
Matej Kramny
df31238a1f Merge pull request #66 from CastawayLabs/feature/upstart-example
Add upstart example
2019-01-08 10:05:23 +08:00
Matej Kramny
a6b879bcee Merge pull request #99 from osallou/fix_set_version
add version information
2019-01-08 10:05:05 +08:00
Matej Kramny
c4f7544640 Merge pull request #92 from srabouin/master
Close HTTP requests
2019-01-08 10:04:19 +08:00
Matej Kramny
ae3a18591f Merge pull request #85 from tolbxela/patch-1
The table in the Templates section was corrected
2019-01-08 10:03:45 +08:00
Matej Kramny
7cbc234c42 Merge pull request #84 from sgreene570/master
Add license and cleanup readme
2019-01-08 10:03:33 +08:00
Matej Kramny
0b63b0e63d Merge pull request #81 from axnsan12/master
fix component status parsing
2019-01-08 10:03:05 +08:00
Olivier Sallou
5d34e1cf38 add version information
Sets at build time the version information with -ldflags "-X
main.version=3.0.0" for example, the --version will display software
version
2018-10-02 10:40:44 +02:00
Steve Rabouin
581b1465e6 Close HTTP requests
Resolves #75
2018-05-04 22:01:30 -04:00
Tolbxela Bot
8bf7a9921e The table in the Templates section was corrected 2017-10-24 11:43:12 +02:00
Stephen Greene
f17ee284a9 Add license and cleanup readme 2017-10-12 21:02:07 -04:00
Cristi Vîjdea
c2c9898d68 fix component status parsing
The Cachet API returns component status as a string,
but cachet-monitor attempts to parse it as int,
resulting in "cannot unmarshal string into Go value of type int".
This applies at least as early as cachet 2.3.12 - 29/06/2017.
2017-10-05 21:02:13 +00:00
Alan Campbell
0ea950f819 Add upstart example 2017-03-20 00:59:10 -04:00
Matej Kramny
0e93d140e8 Merge pull request #61 from mightyfree/patch-1
Update link to example.cachet-monitor.service under Init Script section
2017-03-03 10:36:10 -08:00
mightyfree
aacd04b2b8 Update link to example.cachet-monitor.service under Init Script section
Update link to example.cachet-monitor.service under Init Script Section. Previous relative link 404'd. Updated with absolute path to example.cachet-monitor.service (https://github.com/CastawayLabs/cachet-monitor/blob/master/example.cachet-monitor.service).
2017-03-03 13:29:52 -05:00
Matej Kramny
3a68b19633 Merge pull request #60 from matunixe/patch-2
Add init script setup
2017-03-02 11:05:58 -08:00
Mathias B
423c8d3a23 Add init script setup
Since PR #59 we need to update the documentation to explain clearly how tu use the file example.
2017-03-02 18:49:16 +01:00
Matej Kramny
f48b5feb11 Rename exemple.cachet-monitor.service to example.cachet-monitor.service 2017-03-01 11:35:48 -08:00
Matej Kramny
b7f7f934ec Merge pull request #59 from matunixe/patch-1
Add a file init exemple
2017-03-01 11:29:04 -08:00
Mathias B
927aca5ac0 Add a file init exemple
Here is a Systemd init file, tweak it to your needs!
2017-03-01 17:24:48 +01:00
Matej Kramny
18705d1faf update readme 2017-02-13 14:07:25 -08:00
Matej Kramny
dab2264c7a Comment out unused code 2017-02-12 20:05:04 -08:00
Matej Kramny
021871b763 Add contribution section & code of conduct 2017-02-12 19:55:58 -08:00
Matej Kramny
698781afec update readme 2017-02-12 19:50:03 -08:00
Matej Kramny
e6d8d31fa5 update examples 2017-02-12 17:43:20 -08:00
Matej Kramny
6a51993296 update readme, remove tcp/icmp 2017-02-12 17:35:09 -08:00
Matej Kramny
8aae002623 DNS check 2017-02-12 13:39:37 -08:00
26 changed files with 1206 additions and 161 deletions

3
.gitignore vendored
View File

@@ -1,3 +1,6 @@
/config.yml /config.yml
/config.json /config.json
examples/ examples/
/cachet-monitor
/cli
build

74
CODE_OF_CONDUCT.md Normal file
View File

@@ -0,0 +1,74 @@
# Contributor Covenant Code of Conduct
## Our Pledge
In the interest of fostering an open and welcoming environment, we as
contributors and maintainers pledge to making participation in our project and
our community a harassment-free experience for everyone, regardless of age, body
size, disability, ethnicity, gender identity and expression, level of experience,
nationality, personal appearance, race, religion, or sexual identity and
orientation.
## Our Standards
Examples of behavior that contributes to creating a positive environment
include:
* Using welcoming and inclusive language
* Being respectful of differing viewpoints and experiences
* Gracefully accepting constructive criticism
* Focusing on what is best for the community
* Showing empathy towards other community members
Examples of unacceptable behavior by participants include:
* The use of sexualized language or imagery and unwelcome sexual attention or
advances
* Trolling, insulting/derogatory comments, and personal or political attacks
* Public or private harassment
* Publishing others' private information, such as a physical or electronic
address, without explicit permission
* Other conduct which could reasonably be considered inappropriate in a
professional setting
## Our Responsibilities
Project maintainers are responsible for clarifying the standards of acceptable
behavior and are expected to take appropriate and fair corrective action in
response to any instances of unacceptable behavior.
Project maintainers have the right and responsibility to remove, edit, or
reject comments, commits, code, wiki edits, issues, and other contributions
that are not aligned to this Code of Conduct, or to ban temporarily or
permanently any contributor for other behaviors that they deem inappropriate,
threatening, offensive, or harmful.
## Scope
This Code of Conduct applies both within project spaces and in public spaces
when an individual is representing the project or its community. Examples of
representing a project or community include using an official project e-mail
address, posting via an official social media account, or acting as an appointed
representative at an online or offline event. Representation of a project may be
further defined and clarified by project maintainers.
## Enforcement
Instances of abusive, harassing, or otherwise unacceptable behavior may be
reported by contacting the project team at management@castawaylabs.com. All
complaints will be reviewed and investigated and will result in a response that
is deemed necessary and appropriate to the circumstances. The project team is
obligated to maintain confidentiality with regard to the reporter of an incident.
Further details of specific enforcement policies may be posted separately.
Project maintainers who do not follow or enforce the Code of Conduct in good
faith may face temporary or permanent repercussions as determined by other
members of the project's leadership.
## Attribution
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
available at [http://contributor-covenant.org/version/1/4][version]
[homepage]: http://contributor-covenant.org
[version]: http://contributor-covenant.org/version/1/4/

21
LICENSE.txt Normal file
View File

@@ -0,0 +1,21 @@
MIT License
Copyright (c) 2017 Castaway Labs LLC
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.

8
api.go
View File

@@ -9,7 +9,7 @@ import (
"strconv" "strconv"
"time" "time"
"github.com/Sirupsen/logrus" "github.com/sirupsen/logrus"
) )
type CachetAPI struct { type CachetAPI struct {
@@ -33,6 +33,8 @@ func (api CachetAPI) Ping() error {
return errors.New("API Responded with non-200 status code") return errors.New("API Responded with non-200 status code")
} }
defer resp.Body.Close()
return nil return nil
} }
@@ -49,6 +51,8 @@ func (api CachetAPI) SendMetric(id int, lag int64) {
if err != nil || resp.StatusCode != 200 { if err != nil || resp.StatusCode != 200 {
logrus.Warnf("Could not log metric! ID: %d, err: %v", id, err) logrus.Warnf("Could not log metric! ID: %d, err: %v", id, err)
} }
defer resp.Body.Close()
} }
// TODO: test // TODO: test
@@ -75,5 +79,7 @@ func (api CachetAPI) NewRequest(requestType, url string, reqBody []byte) (*http.
} }
err = json.NewDecoder(res.Body).Decode(&body) err = json.NewDecoder(res.Body).Decode(&body)
defer req.Body.Close()
return res, body, err return res, body, err
} }

12
cli/Dockerfile Normal file
View File

@@ -0,0 +1,12 @@
# build stage
FROM golang:alpine AS build-env
RUN set -eux; \
apk add --no-cache --virtual .build-deps \
git gcc libc-dev;
ENV GO111MODULE on
WORKDIR /go/main
ADD go.mod go.sum ./
RUN go mod download
# WORKDIR /go/src/status-monitor
ADD main.go ./
RUN CGO_ENABLED=0 GOOS=linux go build -ldflags="-s -w" -a -installsuffix cgo -o main main.go

3
cli/Makefile Normal file
View File

@@ -0,0 +1,3 @@
build:
docker build .

12
cli/go.mod Normal file
View File

@@ -0,0 +1,12 @@
module main
go 1.13
require (
github.com/castawaylabs/cachet-monitor v1.1.0 // indirect
github.com/docopt/docopt-go v0.0.0-20180111231733-ee0de3bc6815
github.com/milkinteractive/cachet-monitor v1.1.0
github.com/mitchellh/mapstructure v1.1.2
github.com/sirupsen/logrus v1.4.2
gopkg.in/yaml.v2 v2.2.7
)

20
cli/go.sum Normal file
View File

@@ -0,0 +1,20 @@
github.com/castawaylabs/cachet-monitor v1.1.0 h1:T8NshhwHjEIbdlWkeRBuYdnU2ktpBnZpwgh6nxrp62w=
github.com/castawaylabs/cachet-monitor v1.1.0/go.mod h1:FBK1+4+fLd80wd/+U4Zy8YshPlpgWEvup79AoapOZ2E=
github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
github.com/docopt/docopt-go v0.0.0-20180111231733-ee0de3bc6815 h1:bWDMxwH3px2JBh6AyO7hdCn/PkvCZXii8TGj7sbtEbQ=
github.com/docopt/docopt-go v0.0.0-20180111231733-ee0de3bc6815/go.mod h1:WwZ+bS3ebgob9U8Nd0kOddGdZWjyMGR8Wziv+TBNwSE=
github.com/konsorten/go-windows-terminal-sequences v1.0.1/go.mod h1:T0+1ngSBFLxvqU3pZ+m/2kptfBszLMUkC4ZK/EgS/cQ=
github.com/milkinteractive/cachet-monitor v1.1.0 h1:IyX/gYVDfSEwO4kbNMs9W4hLt5FXIV/ig/4c1nFVlfU=
github.com/milkinteractive/cachet-monitor v1.1.0/go.mod h1:Y+g0f0C8fAj2ub5RhfQgh/oU85pYx6QbL/56WMFkmVo=
github.com/mitchellh/mapstructure v1.1.2 h1:fmNYVwqnSfB9mZU6OS2O6GsXM+wcskZDuKQzvN1EDeE=
github.com/mitchellh/mapstructure v1.1.2/go.mod h1:FVVH3fgwuzCH5S8UJGiWEs2h04kUh9fWfEaFds41c1Y=
github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=
github.com/sirupsen/logrus v1.4.2 h1:SPIRibHv4MatM3XXNO2BJeFLZwZ2LvZgfQ5+UNI2im4=
github.com/sirupsen/logrus v1.4.2/go.mod h1:tLMulIdttU9McNUspp0xgXVQah82FyeX6MwdIuYE2rE=
github.com/stretchr/objx v0.1.1/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME=
github.com/stretchr/testify v1.2.2/go.mod h1:a8OnRcib4nhh0OaRAV+Yts87kKdq0PP7pXfy6kDkUVs=
golang.org/x/sys v0.0.0-20190422165155-953cdadca894 h1:Cz4ceDQGXuKRnVBDTS23GTn/pU5OE2C0WrNTOYK1Uuc=
golang.org/x/sys v0.0.0-20190422165155-953cdadca894/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
gopkg.in/yaml.v2 v2.2.7 h1:VUgggvou5XRW9mHwD/yXxIYSMtY0zoKQf/v226p2nyo=
gopkg.in/yaml.v2 v2.2.7/go.mod h1:hI93XBmqTisBFMUTm0b8Fm+jr3Dg1NNxqwp+5A1VGuI=

View File

@@ -11,19 +11,18 @@ import (
"strings" "strings"
"sync" "sync"
"github.com/Sirupsen/logrus"
cachet "github.com/castawaylabs/cachet-monitor"
docopt "github.com/docopt/docopt-go" docopt "github.com/docopt/docopt-go"
cachet "github.com/milkinteractive/cachet-monitor"
"github.com/mitchellh/mapstructure" "github.com/mitchellh/mapstructure"
"github.com/sirupsen/logrus"
"gopkg.in/yaml.v2" "gopkg.in/yaml.v2"
) )
const usage = `cachet-monitor const usage = `cachet-monitor
Usage: Usage:
cachet-monitor (-c PATH | --config PATH) [--log=LOGPATH] [--name=NAME] [--immediate] cachet-monitor (-c PATH | --config PATH) [--log=LOGPATH] [--name=NAME] [--immediate] [--restarted]
cachet-monitor -h | --help | --version cachet-monitor -h | --help | --version
cachet-monitor print-config
Arguments: Arguments:
PATH path to config.json PATH path to config.json
@@ -39,15 +38,17 @@ Options:
-h --help Show this screen. -h --help Show this screen.
--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)
print-config Print example configuration --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
CACHET_DEV set to enable dev logging` CACHET_DEV set to enable dev logging`
var version string
func main() { func main() {
arguments, _ := docopt.Parse(usage, nil, true, "cachet-monitor", false) arguments, _ := docopt.Parse(usage, nil, true, version, false)
cfg, err := getConfiguration(arguments["--config"].(string)) cfg, err := getConfiguration(arguments["--config"].(string))
if err != nil { if err != nil {
@@ -58,6 +59,10 @@ func main() {
cfg.Immediate = immediate.(bool) cfg.Immediate = immediate.(bool)
} }
if restarted, ok := arguments["--restarted"]; ok {
cfg.Restarted = restarted.(bool)
}
if name := arguments["--name"]; name != nil { if name := arguments["--name"]; name != nil {
cfg.SystemName = name.(string) cfg.SystemName = name.(string)
} }
@@ -171,25 +176,26 @@ func getConfiguration(path string) (*cachet.CachetMonitor, error) {
} }
switch monType { switch monType {
case "http": case "http":
var s cachet.HTTPMonitor var s cachet.HTTPMonitor
err = mapstructure.Decode(rawMonitor, &s) err = mapstructure.Decode(rawMonitor, &s)
t = &s t = &s
case "dns": case "dns":
var s cachet.DNSMonitor var s cachet.DNSMonitor
err = mapstructure.Decode(rawMonitor, &s) err = mapstructure.Decode(rawMonitor, &s)
t = &s t = &s
case "icmp": case "tcp":
var s cachet.ICMPMonitor var s cachet.TCPMonitor
err = mapstructure.Decode(rawMonitor, &s) err = mapstructure.Decode(rawMonitor, &s)
t = &s t = &s
case "tcp":
var s cachet.TCPMonitor case "icmp":
err = mapstructure.Decode(rawMonitor, &s) var s cachet.ICMPMonitor
t = &s err = mapstructure.Decode(rawMonitor, &s)
default: t = &s
logrus.Errorf("Invalid monitor type (index: %d) %v", index, monType) default:
continue logrus.Errorf("Invalid monitor type (index: %d) %v", index, monType)
continue
} }
t.GetMonitor().Type = monType t.GetMonitor().Type = monType
@@ -200,7 +206,7 @@ func getConfiguration(path string) (*cachet.CachetMonitor, error) {
} }
cfg.Monitors[index] = t cfg.Monitors[index] = t
} }
return &cfg, err return &cfg, err
} }

View File

@@ -6,17 +6,19 @@ import (
"strings" "strings"
"time" "time"
"github.com/Sirupsen/logrus" "github.com/sirupsen/logrus"
) )
type CachetMonitor struct { type CachetMonitor struct {
SystemName string `json:"system_name" yaml:"system_name"` SystemName string `json:"system_name" yaml:"system_name"`
DateFormat string `json:"date_format" yaml:"date_format"` DateFormat string `json:"date_format" yaml:"date_format"`
SlackWebhook string `json:"slack_webhook" yaml:"slack_webhook"`
API CachetAPI `json:"api"` API CachetAPI `json:"api"`
RawMonitors []map[string]interface{} `json:"monitors" yaml:"monitors"` RawMonitors []map[string]interface{} `json:"monitors" yaml:"monitors"`
Monitors []MonitorInterface `json:"-" yaml:"-"` Monitors []MonitorInterface `json:"-" yaml:"-"`
Immediate bool `json:"-" yaml:"-"` Immediate bool `json:"-" yaml:"-"`
Restarted bool `json:"-" yaml:"-"`
} }
// Validate configuration // Validate configuration
@@ -87,3 +89,9 @@ func getTemplateData(monitor *AbstractMonitor) map[string]interface{} {
"now": time.Now().Format(monitor.config.DateFormat), "now": time.Now().Format(monitor.config.DateFormat),
} }
} }
func MainUrl(cfg *CachetMonitor) string {
var url = cfg.API.URL
var index = strings.Index(url,"/api/")
return url[0:index]
}

116
dns.go
View File

@@ -1,5 +1,121 @@
package cachet package cachet
import (
"net"
"regexp"
"strings"
"github.com/sirupsen/logrus"
"github.com/miekg/dns"
)
type DNSAnswer struct {
Regex string
regexp *regexp.Regexp
Exact string
}
type DNSMonitor struct { type DNSMonitor struct {
AbstractMonitor `mapstructure:",squash"` AbstractMonitor `mapstructure:",squash"`
// IP:port format or blank to use system defined DNS
DNS string
// A(default), AAAA, MX, ...
Question string
question uint16
Answers []DNSAnswer
}
func (monitor *DNSMonitor) Validate() []string {
errs := monitor.AbstractMonitor.Validate()
if len(monitor.DNS) == 0 {
config, _ := dns.ClientConfigFromFile("/etc/resolv.conf")
if len(config.Servers) > 0 {
monitor.DNS = net.JoinHostPort(config.Servers[0], config.Port)
}
}
if len(monitor.DNS) == 0 {
monitor.DNS = "8.8.8.8:53"
}
if len(monitor.Question) == 0 {
monitor.Question = "A"
}
monitor.Question = strings.ToUpper(monitor.Question)
monitor.question = findDNSType(monitor.Question)
if monitor.question == 0 {
errs = append(errs, "Could not look up DNS question type")
}
for i, a := range monitor.Answers {
if len(a.Regex) > 0 {
monitor.Answers[i].regexp, _ = regexp.Compile(a.Regex)
}
}
return errs
}
func (monitor *DNSMonitor) test() bool {
m := new(dns.Msg)
m.SetQuestion(dns.Fqdn(monitor.Target), monitor.question)
m.RecursionDesired = true
c := new(dns.Client)
r, _, err := c.Exchange(m, monitor.DNS)
if err != nil {
logrus.Warnf("DNS error: %v", err)
return false
}
if r.Rcode != dns.RcodeSuccess {
return false
}
for _, check := range monitor.Answers {
found := false
for _, answer := range r.Answer {
found = matchAnswer(answer, check)
if found {
break
}
}
if !found {
logrus.Warnf("DNS check failed: %v. Not found in any of %v", check, r.Answer)
return false
}
}
return true
}
func findDNSType(t string) uint16 {
for rr, strType := range dns.TypeToString {
if t == strType {
return rr
}
}
return 0
}
func matchAnswer(answer dns.RR, check DNSAnswer) bool {
fields := []string{}
for i := 0; i < dns.NumField(answer); i++ {
fields = append(fields, dns.Field(answer, i+1))
}
str := strings.Join(fields, " ")
if check.regexp != nil {
return check.regexp.Match([]byte(str))
}
return str == check.Exact
} }

View File

@@ -0,0 +1,20 @@
[Unit]
Description=Cachet Monitor
After=syslog.target
After=network.target
#After=mysqld.service
#After=postgresql.service
#After=memcached.service
#After=redis.service
[Service]
Type=simple
User=root
Group=root
WorkingDirectory=/root
ExecStart=/root/cachet-monitor -c /etc/cachet-monitor.yaml
Restart=always
Environment=USER=root HOME=/root
[Install]
WantedBy=multi-user.target

View File

@@ -2,21 +2,70 @@
"api": { "api": {
"url": "https://demo.cachethq.io/api/v1", "url": "https://demo.cachethq.io/api/v1",
"token": "9yMHsdioQosnyVK4iCVR", "token": "9yMHsdioQosnyVK4iCVR",
"insecure": true "insecure": false
}, },
"date_format": "02/01/2006 15:04:05 MST",
"monitors": [ "monitors": [
{ {
"active": false,
"name": "google", "name": "google",
"url": "https://google.com", "target": "https://google.com",
"threshold": 80, "strict": true,
"method": "POST",
"component_id": 1, "component_id": 1,
"interval": 10, "metric_id": 4,
"timeout": 5, "template": {
"investigating": {
"subject": "{{ .Monitor.Name }} - {{ .SystemName }}",
"message": "{{ .Monitor.Name }} check **failed** (server time: {{ .now }})\n\n{{ .FailReason }}"
},
"fixed": {
"subject": "I HAVE BEEN FIXED"
}
},
"interval": 1,
"timeout": 1,
"threshold": 80,
"headers": { "headers": {
"Authorization": "Basic <hash>" "Authorization": "Basic <hash>"
}, },
"expected_status_code": 200, "expected_status_code": 200,
"strict_tls": true "expected_body": "P.*NG"
},
{
"type": "dns",
"active": true,
"name": "dns",
"target": "opnsense.bennetg.dev.",
"question": "a",
"component_id": 2,
"interval": 1,
"timeout": 1,
"dns": "10.0.0.60:53",
"answers": [
{
"exact": "10.0.0.1"
}
]
},
{
"type": "tcp",
"name": "TCP",
"active": false,
"target": "10.0.0.1",
"interval": 10,
"timeout": 1,
"port": "443",
"component_id": 4
},
{
"active": true,
"type": "icmp",
"name": "icmp",
"target": "10.0.0.1",
"component_id": 4,
"interval": 10,
"timeout": 3
} }
] ]
} }

View File

@@ -1,14 +1,70 @@
api: api:
# cachet url
url: https://demo.cachethq.io/api/v1 url: https://demo.cachethq.io/api/v1
# cachet api token
token: 9yMHsdioQosnyVK4iCVR token: 9yMHsdioQosnyVK4iCVR
insecure: false
# https://golang.org/src/time/format.go#L57
date_format: 02/01/2006 15:04:05 MST
slack_webhook: https://hooks.slack.com/services/T00000000/B00000000/XXXXXXXXXXXXXXXXXXXXXXXX
monitors: monitors:
# http monitor example
- name: google - name: google
# test url
target: https://google.com target: https://google.com
threshold: 80 # strict certificate checking for https
strict: true
# HTTP method
method: POST
# set to update component (either component_id or metric_id are required)
component_id: 1 component_id: 1
interval: 10 # set to post lag to cachet metric (graph)
timeout: 5 metric_id: 4
# custom templates (see readme for details)
template:
investigating:
subject: "{{ .Monitor.Name }} - {{ .SystemName }}"
message: "{{ .Monitor.Name }} check **failed** (server time: {{ .now }})\n\n{{ .FailReason }}"
fixed:
subject: "I HAVE BEEN FIXED"
# seconds between checks
interval: 1
# seconds for timeout
timeout: 1
# If % of downtime is over this threshold, open an incident
threshold: 80
# custom HTTP headers
headers: headers:
Authorization: Basic <hash> Authorization: Basic <hash>
# expected status code (either status code or body must be supplied)
expected_status_code: 200 expected_status_code: 200
strict: true # regex to match body
expected_body: "P.*NG"
# dns monitor example
- name: dns
# fqdn
target: matej.me.
# question type (A/AAAA/CNAME/...)
question: mx
type: dns
# set component_id/metric_id
component_id: 2
# poll every 1s
interval: 1
timeout: 1
# custom DNS server (defaults to system)
dns: 8.8.4.4:53
answers:
- regex: [1-9] alt[1-9].aspmx.l.google.com.
- exact: 10 aspmx2.googlemail.com.
- exact: 1 aspmx.l.google.com.
- exact: 10 aspmx3.googlemail.com.
- name: smtpnine
target: smtp.nine.ch
type: tcp
port: 25
component_id: 4

14
example.upstart.conf Normal file
View File

@@ -0,0 +1,14 @@
description "Cachet Monitor"
start on startup
env USER=root
env HOME=/root
setuid root
setgid root
chdir /root
script
exec cachet-monitor -c /cachet-monitor.json --immediate
end script

47
go-executable-build.sh Executable file
View File

@@ -0,0 +1,47 @@
#!/usr/bin/env bash
package=$1
if [[ -z "$package" ]]; then
echo "usage: $0 <package-name>"
exit 1
fi
package_name=$package
#the full list of the platforms: https://golang.org/doc/install/source#environment
platforms=(
# "darwin/386"
# "darwin/amd64"
# "darwin/arm"
# "darwin/arm64"
# "dragonfly/amd64"
# "freebsd/386"
# "freebsd/amd64"
# "freebsd/arm"
# "linux/386"
"linux/amd64"
# "linux/arm"
# "linux/arm64"
# "netbsd/386"
# "netbsd/amd64"
# "netbsd/arm"
# "openbsd/386"
# "openbsd/amd64"
# "openbsd/arm"
# "plan9/386"
# "plan9/amd64"
# "solaris/amd64"
# "windows/amd64"
# "windows/386"
)
for platform in "${platforms[@]}"; do
platform_split=(${platform//\// })
GOOS=${platform_split[0]}
GOARCH=${platform_split[1]}
output_name=build/$package_name'-'$GOOS'-'$GOARCH
if [ $GOOS = "windows" ]; then
output_name+='.exe'
fi
env CGO_ENABLED=1 GOOS=$GOOS GOARCH=$GOARCH go build -o $output_name $package
done

18
go.mod Normal file
View File

@@ -0,0 +1,18 @@
module github.com/milkinteractive/cachet-monitor
go 1.13
require (
github.com/chenjiandongx/yap v0.2.0 // indirect
github.com/docopt/docopt-go v0.0.0-20180111231733-ee0de3bc6815
github.com/konsorten/go-windows-terminal-sequences v1.0.3 // indirect
github.com/miekg/dns v1.1.53
github.com/mitchellh/mapstructure v1.1.2
github.com/prometheus-community/pro-bing v0.1.0 // indirect
github.com/sirupsen/logrus v1.9.0
github.com/stretchr/objx v0.1.1 // indirect
golang.org/x/crypto v0.8.0 // indirect
golang.org/x/tools v0.8.0 // indirect
golang.org/x/xerrors v0.0.0-20191011141410-1b5146add898 // indirect
gopkg.in/yaml.v2 v2.2.7
)

146
go.sum Normal file
View File

@@ -0,0 +1,146 @@
github.com/chenjiandongx/yap v0.2.0 h1:QggNKR8wJdvHGFCWAWwRgPb5O4oTG3BnTqg03ukrKvg=
github.com/chenjiandongx/yap v0.2.0/go.mod h1:gCZjg9aqv/RcLpWictmDlDSUk+vBS/GAxoJbLJnSw48=
github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c=
github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
github.com/docopt/docopt-go v0.0.0-20180111231733-ee0de3bc6815 h1:bWDMxwH3px2JBh6AyO7hdCn/PkvCZXii8TGj7sbtEbQ=
github.com/docopt/docopt-go v0.0.0-20180111231733-ee0de3bc6815/go.mod h1:WwZ+bS3ebgob9U8Nd0kOddGdZWjyMGR8Wziv+TBNwSE=
github.com/google/gopacket v1.1.19 h1:ves8RnFZPGiFnTS0uPQStjwru6uO6h+nlr9j6fL7kF8=
github.com/google/gopacket v1.1.19/go.mod h1:iJ8V8n6KS+z2U1A8pUwu8bW5SyEMkXJB8Yo/Vo+TKTo=
github.com/google/uuid v1.3.0 h1:t6JiXgmwXMjEs8VusXIJk2BXHsn+wx8BZdTaoZ5fu7I=
github.com/google/uuid v1.3.0/go.mod h1:TIyPZe4MgqvfeYDBFedMoGGpEw/LqOeaOT+nhxU+yHo=
github.com/konsorten/go-windows-terminal-sequences v1.0.1 h1:mweAR1A6xJ3oS2pRaGiHgQ4OO8tzTaLawm8vnODuwDk=
github.com/konsorten/go-windows-terminal-sequences v1.0.1/go.mod h1:T0+1ngSBFLxvqU3pZ+m/2kptfBszLMUkC4ZK/EgS/cQ=
github.com/konsorten/go-windows-terminal-sequences v1.0.2 h1:DB17ag19krx9CFsz4o3enTrPXyIXCl+2iCXH/aMAp9s=
github.com/konsorten/go-windows-terminal-sequences v1.0.2/go.mod h1:T0+1ngSBFLxvqU3pZ+m/2kptfBszLMUkC4ZK/EgS/cQ=
github.com/konsorten/go-windows-terminal-sequences v1.0.3/go.mod h1:T0+1ngSBFLxvqU3pZ+m/2kptfBszLMUkC4ZK/EgS/cQ=
github.com/miekg/dns v1.1.27 h1:aEH/kqUzUxGJ/UHcEKdJY+ugH6WEzsEBBSPa8zuy1aM=
github.com/miekg/dns v1.1.27/go.mod h1:KNUDUusw/aVsxyTYZM1oqvCicbwhgbNgztCETuNZ7xM=
github.com/miekg/dns v1.1.29 h1:xHBEhR+t5RzcFJjBLJlax2daXOrTYtr9z4WdKEfWFzg=
github.com/miekg/dns v1.1.29/go.mod h1:KNUDUusw/aVsxyTYZM1oqvCicbwhgbNgztCETuNZ7xM=
github.com/miekg/dns v1.1.34 h1:SgTzfkN+oLoIHF1bgUP+C71mzuDl3AhLApHzCCIAMWM=
github.com/miekg/dns v1.1.34/go.mod h1:KNUDUusw/aVsxyTYZM1oqvCicbwhgbNgztCETuNZ7xM=
github.com/miekg/dns v1.1.53 h1:ZBkuHr5dxHtB1caEOlZTLPo7D3L3TWckgUUs/RHfDxw=
github.com/miekg/dns v1.1.53/go.mod h1:uInx36IzPl7FYnDcMeVWxj9byh7DutNykX4G9Sj60FY=
github.com/mitchellh/mapstructure v1.1.2 h1:fmNYVwqnSfB9mZU6OS2O6GsXM+wcskZDuKQzvN1EDeE=
github.com/mitchellh/mapstructure v1.1.2/go.mod h1:FVVH3fgwuzCH5S8UJGiWEs2h04kUh9fWfEaFds41c1Y=
github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM=
github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=
github.com/prometheus-community/pro-bing v0.1.0 h1:zjzLGhfNPP0bP1OlzGB+SJcguOViw7df12LPg2vUJh8=
github.com/prometheus-community/pro-bing v0.1.0/go.mod h1:BpWlHurD9flHtzq8wrh8QGWYz9ka9z9ZJAyOel8ej58=
github.com/sirupsen/logrus v1.4.2 h1:SPIRibHv4MatM3XXNO2BJeFLZwZ2LvZgfQ5+UNI2im4=
github.com/sirupsen/logrus v1.4.2/go.mod h1:tLMulIdttU9McNUspp0xgXVQah82FyeX6MwdIuYE2rE=
github.com/sirupsen/logrus v1.5.0 h1:1N5EYkVAPEywqZRJd7cwnRtCb6xJx7NH3T3WUTF980Q=
github.com/sirupsen/logrus v1.5.0/go.mod h1:+F7Ogzej0PZc/94MaYx/nvG9jOFMD2osvC3s+Squfpo=
github.com/sirupsen/logrus v1.7.0 h1:ShrD1U9pZB12TX0cVy0DtePoCH97K8EtX+mg7ZARUtM=
github.com/sirupsen/logrus v1.7.0/go.mod h1:yWOB1SBYBC5VeMP7gHvWumXLIWorT60ONWic61uBYv0=
github.com/sirupsen/logrus v1.9.0 h1:trlNQbNUG3OdDrDil03MCb1H2o9nJ1x4/5LYw7byDE0=
github.com/sirupsen/logrus v1.9.0/go.mod h1:naHLuLoDiP4jHNo9R0sCBMtWGeIprob74mVsIT4qYEQ=
github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME=
github.com/stretchr/objx v0.1.1/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME=
github.com/stretchr/testify v1.2.2 h1:bSDNvY7ZPG5RlJ8otE/7V6gMiyenm9RtJ7IUVIAoJ1w=
github.com/stretchr/testify v1.2.2/go.mod h1:a8OnRcib4nhh0OaRAV+Yts87kKdq0PP7pXfy6kDkUVs=
github.com/stretchr/testify v1.7.0 h1:nwc3DEeHmmLAfoZucVR881uASk0Mfjw8xYJ99tb5CcY=
github.com/stretchr/testify v1.7.0/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg=
github.com/yuin/goldmark v1.4.13/go.mod h1:6yULJ656Px+3vBD8DxQVa3kxgyrAnzto9xy5taEt/CY=
golang.org/x/crypto v0.0.0-20190308221718-c2843e01d9a2/go.mod h1:djNgcEr1/C05ACkg1iLfiJU5Ep61QUkGW8qpdssI0+w=
golang.org/x/crypto v0.0.0-20191011191535-87dc89f01550 h1:ObdrDkeb4kJdCP557AjRjq69pTHfNouLtWZG7j9rPN8=
golang.org/x/crypto v0.0.0-20191011191535-87dc89f01550/go.mod h1:yigFU9vqHzYiE8UmvKecakEJjdnWj3jj499lnFckfCI=
golang.org/x/crypto v0.0.0-20200108215511-5d647ca15757 h1:pJ9H8lzdBh301qPX4VpwJ8TRpLt1IhNK1PxVOICyP54=
golang.org/x/crypto v0.0.0-20200108215511-5d647ca15757/go.mod h1:LzIPMQfyMNhhGPhUkYOs5KpL4U8rLKemX1yGLhDgUto=
golang.org/x/crypto v0.0.0-20200117160349-530e935923ad h1:Jh8cai0fqIK+f6nG0UgPW5wFk8wmiMhM3AyciDBdtQg=
golang.org/x/crypto v0.0.0-20200117160349-530e935923ad/go.mod h1:LzIPMQfyMNhhGPhUkYOs5KpL4U8rLKemX1yGLhDgUto=
golang.org/x/crypto v0.0.0-20200323165209-0ec3e9974c59 h1:3zb4D3T4G8jdExgVU/95+vQXfpEPiMdCaZgmGVxjNHM=
golang.org/x/crypto v0.0.0-20200323165209-0ec3e9974c59/go.mod h1:LzIPMQfyMNhhGPhUkYOs5KpL4U8rLKemX1yGLhDgUto=
golang.org/x/crypto v0.0.0-20200622213623-75b288015ac9/go.mod h1:LzIPMQfyMNhhGPhUkYOs5KpL4U8rLKemX1yGLhDgUto=
golang.org/x/crypto v0.0.0-20201016220609-9e8e0b390897 h1:pLI5jrR7OSLijeIDcmRxNmw2api+jEfxLoykJVice/E=
golang.org/x/crypto v0.0.0-20201016220609-9e8e0b390897/go.mod h1:LzIPMQfyMNhhGPhUkYOs5KpL4U8rLKemX1yGLhDgUto=
golang.org/x/crypto v0.0.0-20210921155107-089bfa567519/go.mod h1:GvvjBRRGRdwPK5ydBHafDWAxML/pGHZbMvKqRZ5+Abc=
golang.org/x/crypto v0.8.0 h1:pd9TJtTueMTVQXzk8E2XESSMQDj/U7OUu0PqJqPXQjQ=
golang.org/x/crypto v0.8.0/go.mod h1:mRqEX+O9/h5TFCrQhkgjo2yKi0yYA+9ecGkdQoHrywE=
golang.org/x/lint v0.0.0-20200302205851-738671d3881b/go.mod h1:3xt1FjdF8hUf6vQPIChWIBhFzV8gjjsPE/fR3IyQdNY=
golang.org/x/mod v0.1.1-0.20191105210325-c90efee705ee/go.mod h1:QqPTAvyqsEbceGzBzNggFXnrqF1CaUcvgkdR5Ot7KZg=
golang.org/x/mod v0.6.0-dev.0.20220419223038-86c51ed26bb4/go.mod h1:jJ57K6gSWd91VN4djpZkiMVwK6gcyfeH4XE8wZrZaV4=
golang.org/x/mod v0.7.0/go.mod h1:iBbtSCu2XBx23ZKBPSOrRkjjQPZFPuis4dIYUhu/chs=
golang.org/x/mod v0.8.0/go.mod h1:iBbtSCu2XBx23ZKBPSOrRkjjQPZFPuis4dIYUhu/chs=
golang.org/x/mod v0.10.0 h1:lFO9qtOdlre5W1jxS3r/4szv2/6iXxScdzjoBMXNhYk=
golang.org/x/mod v0.10.0/go.mod h1:iBbtSCu2XBx23ZKBPSOrRkjjQPZFPuis4dIYUhu/chs=
golang.org/x/net v0.0.0-20190404232315-eb5bcb51f2a3/go.mod h1:t9HGtf8HONx5eT2rtn7q6eTqICYqUVnKs3thJo3Qplg=
golang.org/x/net v0.0.0-20190620200207-3b0461eec859/go.mod h1:z5CRVTTTmAJ677TzLLGU+0bjPO0LkuOLi4/5GtJWs/s=
golang.org/x/net v0.0.0-20190923162816-aa69164e4478 h1:l5EDrHhldLYb3ZRHDUhXF7Om7MvYXnkV9/iQNo1lX6g=
golang.org/x/net v0.0.0-20190923162816-aa69164e4478/go.mod h1:z5CRVTTTmAJ677TzLLGU+0bjPO0LkuOLi4/5GtJWs/s=
golang.org/x/net v0.0.0-20191209160850-c0dbc17a3553 h1:efeOvDhwQ29Dj3SdAV/MJf8oukgn+8D8WgaCaRMchF8=
golang.org/x/net v0.0.0-20191209160850-c0dbc17a3553/go.mod h1:z5CRVTTTmAJ677TzLLGU+0bjPO0LkuOLi4/5GtJWs/s=
golang.org/x/net v0.0.0-20200114155413-6afb5195e5aa h1:F+8P+gmewFQYRk6JoLQLwjBCTu3mcIURZfNkVweuRKA=
golang.org/x/net v0.0.0-20200114155413-6afb5195e5aa/go.mod h1:z5CRVTTTmAJ677TzLLGU+0bjPO0LkuOLi4/5GtJWs/s=
golang.org/x/net v0.0.0-20200324143707-d3edc9973b7e h1:3G+cUijn7XD+S4eJFddp53Pv7+slrESplyjG25HgL+k=
golang.org/x/net v0.0.0-20200324143707-d3edc9973b7e/go.mod h1:qpuaurCH72eLCgpAm/N6yyVIVM9cpaDIP3A8BGJEC5A=
golang.org/x/net v0.0.0-20201016165138-7b1cca2348c0 h1:5kGOVHlq0euqwzgTC9Vu15p6fV1Wi0ArVi8da2urnVg=
golang.org/x/net v0.0.0-20201016165138-7b1cca2348c0/go.mod h1:sp8m0HH+o8qH0wwXwYZr8TS3Oi6o0r6Gce1SSxlDquU=
golang.org/x/net v0.0.0-20201224014010-6772e930b67b/go.mod h1:m0MpNAwzfU5UDzcl9v0D8zg8gWTRqZa9RBIspLL5mdg=
golang.org/x/net v0.0.0-20210226172049-e18ecbb05110/go.mod h1:m0MpNAwzfU5UDzcl9v0D8zg8gWTRqZa9RBIspLL5mdg=
golang.org/x/net v0.0.0-20220615171555-694bf12d69de/go.mod h1:XRhObCWvk6IyKnWLug+ECip1KBveYUHfp+8e9klMJ9c=
golang.org/x/net v0.0.0-20220722155237-a158d28d115b/go.mod h1:XRhObCWvk6IyKnWLug+ECip1KBveYUHfp+8e9klMJ9c=
golang.org/x/net v0.2.0/go.mod h1:KqCZLdyyvdV855qA2rE3GC2aiw5xGR5TEjj8smXukLY=
golang.org/x/net v0.6.0/go.mod h1:2Tu9+aMcznHK/AK1HMvgo6xiTLG5rD5rZLDS+rp2Bjs=
golang.org/x/net v0.9.0 h1:aWJ/m6xSmxWBx+V0XRHTlrYrPG56jKsLdTFmsSsCzOM=
golang.org/x/net v0.9.0/go.mod h1:d48xBJpPfHeWQsugry2m+kC02ZBRGRgulfHnEXEuWns=
golang.org/x/sync v0.0.0-20190423024810-112230192c58 h1:8gQV6CLnAEikrhgkHFbMAEhagSSnXWGV915qUMm9mrU=
golang.org/x/sync v0.0.0-20190423024810-112230192c58/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM=
golang.org/x/sync v0.0.0-20220601150217-0de741cfad7f/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM=
golang.org/x/sync v0.0.0-20220722155255-886fb9371eb4/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM=
golang.org/x/sync v0.1.0 h1:wsuoTGHzEhffawBOhz5CYhcrV4IdKZbEyZjBMuTp12o=
golang.org/x/sync v0.1.0/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM=
golang.org/x/sys v0.0.0-20190215142949-d0b11bdaac8a/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY=
golang.org/x/sys v0.0.0-20190412213103-97732733099d/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
golang.org/x/sys v0.0.0-20190422165155-953cdadca894/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
golang.org/x/sys v0.0.0-20190924154521-2837fb4f24fe h1:6fAMxZRR6sl1Uq8U61gxU+kPTs2tR8uOySCbBP7BN/M=
golang.org/x/sys v0.0.0-20190924154521-2837fb4f24fe/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
golang.org/x/sys v0.0.0-20191026070338-33540a1f6037/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
golang.org/x/sys v0.0.0-20200107162124-548cf772de50 h1:YvQ10rzcqWXLlJZ3XCUoO25savxmscf4+SC+ZqiCHhA=
golang.org/x/sys v0.0.0-20200107162124-548cf772de50/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
golang.org/x/sys v0.0.0-20200124204421-9fbb57f87de9 h1:1/DFK4b7JH8DmkqhUk48onnSfrPzImPoVxuomtbT2nk=
golang.org/x/sys v0.0.0-20200124204421-9fbb57f87de9/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
golang.org/x/sys v0.0.0-20200323222414-85ca7c5b95cd/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
golang.org/x/sys v0.0.0-20200327173247-9dae0f8f5775 h1:TC0v2RSO1u2kn1ZugjrFXkRZAEaqMN/RW+OTZkBzmLE=
golang.org/x/sys v0.0.0-20200327173247-9dae0f8f5775/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
golang.org/x/sys v0.0.0-20200930185726-fdedc70b468f/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
golang.org/x/sys v0.0.0-20201018230417-eeed37f84f13 h1:5jaG59Zhd+8ZXe8C+lgiAGqkOaZBruqrWclLkgAww34=
golang.org/x/sys v0.0.0-20201018230417-eeed37f84f13/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
golang.org/x/sys v0.0.0-20201119102817-f84b799fce68/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
golang.org/x/sys v0.0.0-20210615035016-665e8c7367d1/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
golang.org/x/sys v0.0.0-20220520151302-bc2c85ada10a/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
golang.org/x/sys v0.0.0-20220615213510-4f61da869c0c/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
golang.org/x/sys v0.0.0-20220715151400-c0bba94af5f8/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
golang.org/x/sys v0.0.0-20220722155257-8c9f86f7a55f/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
golang.org/x/sys v0.2.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
golang.org/x/sys v0.5.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
golang.org/x/sys v0.7.0 h1:3jlCCIQZPdOYu1h8BkNvLz8Kgwtae2cagcG/VamtZRU=
golang.org/x/sys v0.7.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
golang.org/x/term v0.0.0-20201126162022-7de9c90e9dd1/go.mod h1:bj7SfCRtBDWHUb9snDiAeCFNEtKQo2Wmx5Cou7ajbmo=
golang.org/x/term v0.0.0-20210927222741-03fcf44c2211/go.mod h1:jbD1KX2456YbFQfuXm/mYQcufACuNUgVhRMnK/tPxf8=
golang.org/x/term v0.2.0/go.mod h1:TVmDHMZPmdnySmBfhjOoOdhjzdE1h4u1VwSiw2l1Nuc=
golang.org/x/term v0.5.0/go.mod h1:jMB1sMXY+tzblOD4FWmEbocvup2/aLOaQEp7JmGp78k=
golang.org/x/term v0.7.0/go.mod h1:P32HKFT3hSsZrRxla30E9HqToFYAQPCMs/zFMBUFqPY=
golang.org/x/text v0.3.0/go.mod h1:NqM8EUOU14njkJ3fqMW+pc6Ldnwhi/IjpwHt7yyuwOQ=
golang.org/x/text v0.3.3/go.mod h1:5Zoc/QRtKVWzQhOtBMvqHzDpF6irO9z98xDceosuGiQ=
golang.org/x/text v0.3.7/go.mod h1:u+2+/6zg+i71rQMx5EYifcz6MCKuco9NR6JIITiCfzQ=
golang.org/x/text v0.4.0/go.mod h1:mrYo+phRRbMaCq/xk9113O4dZlRixOauAjOtrjsXDZ8=
golang.org/x/text v0.7.0/go.mod h1:mrYo+phRRbMaCq/xk9113O4dZlRixOauAjOtrjsXDZ8=
golang.org/x/text v0.9.0/go.mod h1:e1OnstbJyHTd6l/uOt8jFFHp6TRDWZR/bV3emEE/zU8=
golang.org/x/tools v0.0.0-20180917221912-90fa682c2a6e/go.mod h1:n7NCudcB/nEzxVGmLbDWY5pfWTLqBcC2KZ6jyYvM4mQ=
golang.org/x/tools v0.0.0-20191119224855-298f0cb1881e/go.mod h1:b+2E5dAYhXwXZwtnZ6UAqBI28+e2cm9otk0dWdXHAEo=
golang.org/x/tools v0.0.0-20191216052735-49a3e744a425/go.mod h1:TB2adYChydJhpapKDTa4BR/hXlZSLoq2Wpct/0txZ28=
golang.org/x/tools v0.0.0-20200130002326-2f3ba24bd6e7/go.mod h1:TB2adYChydJhpapKDTa4BR/hXlZSLoq2Wpct/0txZ28=
golang.org/x/tools v0.1.12/go.mod h1:hNGJHUnrk76NpqgfD5Aqm5Crs+Hm0VOH/i9J2+nxYbc=
golang.org/x/tools v0.3.0/go.mod h1:/rWhSS2+zyEVwoJf8YAX6L2f0ntZ7Kn/mGgAWcipA5k=
golang.org/x/tools v0.6.0/go.mod h1:Xwgl3UAJ/d3gWutnCtw505GrjyAbvKui8lOU390QaIU=
golang.org/x/tools v0.8.0 h1:vSDcovVPld282ceKgDimkRSC8kpaH1dgyc9UMzlt84Y=
golang.org/x/tools v0.8.0/go.mod h1:JxBZ99ISMI5ViVkT1tr6tdNmXeTrcpVSD3vZ1RsRdN4=
golang.org/x/xerrors v0.0.0-20190717185122-a985d3407aa7/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0=
golang.org/x/xerrors v0.0.0-20191011141410-1b5146add898/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0=
gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405 h1:yhCVgyC4o1eVCa2tZl7eS0r+SDo693bJlVdllGtEeKM=
gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
gopkg.in/yaml.v2 v2.2.7 h1:VUgggvou5XRW9mHwD/yXxIYSMtY0zoKQf/v226p2nyo=
gopkg.in/yaml.v2 v2.2.7/go.mod h1:hI93XBmqTisBFMUTm0b8Fm+jr3Dg1NNxqwp+5A1VGuI=
gopkg.in/yaml.v3 v3.0.0-20200313102051-9f266ea9e77c/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=

43
http.go
View File

@@ -1,7 +1,9 @@
package cachet package cachet
import ( import (
"crypto/md5"
"crypto/tls" "crypto/tls"
"fmt"
"io/ioutil" "io/ioutil"
"net/http" "net/http"
"regexp" "regexp"
@@ -38,11 +40,27 @@ type HTTPMonitor struct {
// compiled to Regexp // compiled to Regexp
ExpectedBody string `mapstructure:"expected_body"` ExpectedBody string `mapstructure:"expected_body"`
bodyRegexp *regexp.Regexp bodyRegexp *regexp.Regexp
// content check
ExpectedMd5Sum string `mapstructure:"expected_md5sum"`
ExpectedLength int `mapstructure:"expected_length"`
// data
Data string `mapstructure:"data"`
} }
// TODO: test // TODO: test
func (monitor *HTTPMonitor) test() bool { func (monitor *HTTPMonitor) test() bool {
req, err := http.NewRequest(monitor.Method, monitor.Target, nil) var req *http.Request
var err error
if monitor.Data != "" {
dataBuffer := strings.NewReader(monitor.Data)
req, err = http.NewRequest(monitor.Method, monitor.Target, dataBuffer)
} else {
req, err = http.NewRequest(monitor.Method, monitor.Target, nil)
}
for k, v := range monitor.Headers { for k, v := range monitor.Headers {
req.Header.Add(k, v) req.Header.Add(k, v)
} }
@@ -67,14 +85,27 @@ func (monitor *HTTPMonitor) test() bool {
return false return false
} }
if monitor.bodyRegexp != nil { responseBody, err := ioutil.ReadAll(resp.Body)
// check response body responseLength := len(string(responseBody))
responseBody, err := ioutil.ReadAll(resp.Body) if err != nil {
if err != nil { monitor.lastFailReason = err.Error()
monitor.lastFailReason = err.Error() return false
}
if monitor.ExpectedLength > 0 && responseLength != monitor.ExpectedLength {
monitor.lastFailReason = "Expected response body length: " + strconv.Itoa(monitor.ExpectedLength) + ", got: " + strconv.Itoa(responseLength)
return false
}
if monitor.ExpectedMd5Sum != "" {
sum := fmt.Sprintf("%x", (md5.Sum(responseBody)))
if strings.Compare(sum, monitor.ExpectedMd5Sum) != 0 {
monitor.lastFailReason = "Expected respsone body MD5 checksum: " + monitor.ExpectedMd5Sum + ", got: " + sum
return false return false
} }
}
if monitor.bodyRegexp != nil {
if !monitor.bodyRegexp.Match(responseBody) { if !monitor.bodyRegexp.Match(responseBody) {
monitor.lastFailReason = "Unexpected body: " + string(responseBody) + ".\nExpected to match: " + monitor.ExpectedBody monitor.lastFailReason = "Unexpected body: " + string(responseBody) + ".\nExpected to match: " + monitor.ExpectedBody
return false return false

72
icmp.go
View File

@@ -1,5 +1,77 @@
// Thanks go to https://github.com/Soontao/cachet-monitor/blob/master/tcp.go
package cachet package cachet
import (
"fmt"
"github.com/chenjiandongx/yap"
)
// Investigating template
var defaultICMPInvestigatingTpl = MessageTemplate{
Subject: `{{ .Monitor.Name }} - {{ .SystemName }}`,
Message: `{{ .Monitor.Name }} check **failed** (server time: {{ .now }})
{{ .FailReason }}`,
}
// Fixed template
var defaultICMPFixedTpl = MessageTemplate{
Subject: `{{ .Monitor.Name }} - {{ .SystemName }}`,
Message: `**Resolved** - {{ .now }}
Down seconds: {{ .downSeconds }}s`,
}
// ICMPMonitor struct
type ICMPMonitor struct { type ICMPMonitor struct {
AbstractMonitor `mapstructure:",squash"` AbstractMonitor `mapstructure:",squash"`
} }
// CheckICMPAlive func
func CheckICMPAlive(ip string, timeout int) (bool, error) {
pg, err := yap.NewPinger()
if err != nil {
defer pg.Close()
}
response := pg.Call(yap.Request{
Target: ip,
Count: 1,
Timeout: timeout * 1000})
if response.Error != nil {
return false, response.Error
} else {
return true, nil
}
}
// test if it available
func (m *ICMPMonitor) test() bool {
if alive, e := CheckICMPAlive(m.Target, int(m.Timeout)); alive {
return true
} else {
m.lastFailReason = fmt.Sprintf("ICMP check failed: %v", e)
return false
}
}
// Validate configuration
func (m *ICMPMonitor) Validate() []string {
// set incident temp
m.Template.Investigating.SetDefault(defaultICMPInvestigatingTpl)
m.Template.Fixed.SetDefault(defaultICMPFixedTpl)
// super.Validate()
errs := m.AbstractMonitor.Validate()
if m.Target == "" {
errs = append(errs, "Target is required")
}
return errs
}

View File

@@ -4,8 +4,9 @@ import (
"encoding/json" "encoding/json"
"fmt" "fmt"
"strconv" "strconv"
"time"
"github.com/Sirupsen/logrus" "github.com/sirupsen/logrus"
) )
// Incident Cachet data model // Incident Cachet data model
@@ -14,13 +15,39 @@ type Incident struct {
Name string `json:"name"` Name string `json:"name"`
Message string `json:"message"` Message string `json:"message"`
Status int `json:"status"` Status int `json:"status"`
Visible int `json"visible"` Visible int `json:"visible"`
Notify bool `json:"notify"` Notify bool `json:"notify"`
ComponentID int `json:"component_id"` ComponentID int `json:"component_id"`
ComponentStatus int `json:"component_status"` ComponentStatus int `json:"component_status"`
} }
//Get the last still open incident
func (mon *AbstractMonitor) Get(cfg *CachetMonitor) (*Incident, error) {
requestType := "GET"
requestURL := fmt.Sprintf("/incidents?component_id=%d", mon.ComponentID)
_, body, err := cfg.API.NewRequest(requestType, requestURL, nil)
if err != nil {
return nil, err
}
data := make([]Incident, 0)
if err := json.Unmarshal(body.Data, &data); err != nil {
return nil, fmt.Errorf("Cannot parse incident body: %v, %v", err, string(body.Data))
}
//filter out resolved incidents
openIncidents := make([]Incident, 0)
for _, i := range data {
if i.Status < 4 {
openIncidents = append(openIncidents, i)
}
}
if len(openIncidents) == 0 {
return nil, nil
}
return &openIncidents[0], nil
}
// Send - Create or Update incident // Send - Create or Update incident
func (incident *Incident) Send(cfg *CachetMonitor) error { func (incident *Incident) Send(cfg *CachetMonitor) error {
switch incident.Status { switch incident.Status {
@@ -65,9 +92,12 @@ func (incident *Incident) Send(cfg *CachetMonitor) error {
incident.ID = data.ID incident.ID = data.ID
if resp.StatusCode != 200 { if resp.StatusCode != 200 {
return fmt.Errorf("Could not create/update incident!") return fmt.Errorf("Could not create/update incident")
}
// send slack message
if cfg.SlackWebhook != "" {
incident.sendSlack(cfg)
} }
return nil return nil
} }
@@ -110,3 +140,30 @@ func (incident *Incident) SetWatching() {
func (incident *Incident) SetFixed() { func (incident *Incident) SetFixed() {
incident.Status = 4 incident.Status = 4
} }
// Send slack message
func (incident *Incident) sendSlack(cfg *CachetMonitor) {
color := "#bf1932" //red
if incident.ComponentStatus == 1 {
color = "#36a64f" //green
}
titleLink := MainUrl(cfg) + "/dashboard/incidents/" + strconv.Itoa(incident.ID)
slack := Slack{
WebhookURL: cfg.SlackWebhook,
Attachments: []Attachments{
Attachments{
Fallback: incident.Name,
Color: color,
Title: incident.Name,
TitleLink: titleLink,
Text: incident.Message,
Footer: "Cachet Monitor",
FooterIcon: "https://i.imgur.com/spck1w6.png",
Ts: time.Now().Unix(),
},
}}
err := slack.SendSlackNotification()
if err != nil {
fmt.Errorf("Cannot send slack message. Err = %v", err)
}
}

View File

@@ -4,7 +4,7 @@ import (
"sync" "sync"
"time" "time"
"github.com/Sirupsen/logrus" "github.com/sirupsen/logrus"
) )
const DefaultInterval = time.Second * 60 const DefaultInterval = time.Second * 60
@@ -27,8 +27,9 @@ type MonitorInterface interface {
type AbstractMonitor struct { type AbstractMonitor struct {
Name string Name string
Target string Target string
Active bool
// (default)http, tcp, dns, icmp // (default)http / dns
Type string Type string
Strict bool Strict bool
@@ -50,10 +51,10 @@ type AbstractMonitor struct {
// lag / average(lagHistory) * 100 = percentage above average lag // lag / average(lagHistory) * 100 = percentage above average lag
// PerformanceThreshold sets the % limit above which this monitor will trigger degraded-performance // PerformanceThreshold sets the % limit above which this monitor will trigger degraded-performance
PerformanceThreshold float32 // PerformanceThreshold float32
history []bool history []bool
lagHistory []float32 // lagHistory []float32
lastFailReason string lastFailReason string
incident *Incident incident *Incident
config *CachetMonitor config *CachetMonitor
@@ -107,10 +108,17 @@ func (mon *AbstractMonitor) Describe() []string {
features = append(features, "Name: "+mon.Name) features = append(features, "Name: "+mon.Name)
} }
if !mon.Active {
features = append(features, "Active: No")
}
return features return features
} }
func (mon *AbstractMonitor) ClockStart(cfg *CachetMonitor, iface MonitorInterface, wg *sync.WaitGroup) { func (mon *AbstractMonitor) ClockStart(cfg *CachetMonitor, iface MonitorInterface, wg *sync.WaitGroup) {
if !mon.Active {
return
};
wg.Add(1) wg.Add(1)
mon.config = cfg mon.config = cfg
mon.stopC = make(chan bool) mon.stopC = make(chan bool)
@@ -118,6 +126,16 @@ func (mon *AbstractMonitor) ClockStart(cfg *CachetMonitor, iface MonitorInterfac
mon.tick(iface) mon.tick(iface)
} }
if cfg.Restarted {
initialIncident, err := mon.Get(cfg)
if err != nil {
logrus.Warn("could not fetch initial incident: %v", err)
}
if initialIncident != nil {
mon.incident = initialIncident
}
}
ticker := time.NewTicker(mon.Interval * time.Second) ticker := time.NewTicker(mon.Interval * time.Second)
for { for {
select { select {
@@ -141,7 +159,6 @@ func (mon *AbstractMonitor) ClockStop() {
func (mon *AbstractMonitor) test() bool { return false } func (mon *AbstractMonitor) test() bool { return false }
// TODO: test
func (mon *AbstractMonitor) tick(iface MonitorInterface) { func (mon *AbstractMonitor) tick(iface MonitorInterface) {
reqStart := getMs() reqStart := getMs()
up := iface.test() up := iface.test()
@@ -153,7 +170,7 @@ func (mon *AbstractMonitor) tick(iface MonitorInterface) {
} }
if len(mon.history) == histSize-1 { if len(mon.history) == histSize-1 {
logrus.Warnf("%v is now saturated\n", mon.Name) logrus.Warnf("%v is now saturated", mon.Name)
} }
if len(mon.history) >= histSize { if len(mon.history) >= histSize {
mon.history = mon.history[len(mon.history)-(histSize-1):] mon.history = mon.history[len(mon.history)-(histSize-1):]

7
monitor_test.go Normal file
View File

@@ -0,0 +1,7 @@
package cachet
import (
"testing"
)
func TestAnalyseData(t *testing.T) {}

277
readme.md
View File

@@ -1,123 +1,212 @@
![screenshot](https://castawaylabs.github.io/cachet-monitor/screenshot.png) # cachet-monitor
Features a fork of the cachet-monitor project originally developed by CastawayLabs but abandoned. Extended with new features needed by the people.
--------
- [x] Creates & Resolves Incidents ## Features
- [x] Check URLs by response code and/or body contents
- [x] Posts monitor lag to cachet graphs
- [x] Updates Component to 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
Configuration :heavy_check_mark: Interval based checking of predefined Resources
------------- :heavy_check_mark: Posts monitor lag to cachet graphs
:heavy_check_mark: Creates & Resolves Incidents
:heavy_check_mark: Updates Component to Partial Outage
:heavy_check_mark: Updates Component to Major Outage if already in Partial Outage (works with distributed monitors)
:heavy_check_mark: Can be run on multiple servers and geo regions
:heavy_check_mark: HTTP Checks (body/status code)
:heavy_check_mark: DNS Checks
:heavy_check_mark: TCP Checks
:heavy_check_mark: ICMP Checks
``` ## Quick Start
Configuration can be done in either yaml or json format. An example JSON-File would look something like this:
```json
{ {
// URL for the API. Note: Must end with /api/v1 "api": {
"api_url": "https://<cachet domain>/api/v1", "url": "https://demo.cachethq.io/api/v1",
// Your API token for Cachet "token": "9yMHsdioQosnyVK4iCVR",
"api_token": "<cachet api token>", "insecure": false
// optional, false default, set if your certificate is self-signed/untrusted },
"insecure_api": false, "date_format": "02/01/2006 15:04:05 MST",
"monitors": [{ "monitors": [
// required, friendly name for your monitor {
"name": "Name of your monitor", "active": false,
// required, url to probe "name": "google",
"url": "Ping URL", "target": "https://google.com",
// optional, http method (defaults GET) "strict": true,
"method": "get", "method": "POST",
// optional, http Headers to add (default none) "component_id": 1,
"headers": [ "metric_id": 4,
// specify Name and Value of Http-Header, eg. Authorization "template": {
{ "name": "Authorization", "value": "Basic <hash>" } "investigating": {
], "subject": "{{ .Monitor.Name }} - {{ .SystemName }}",
// self-signed ssl certificate "message": "{{ .Monitor.Name }} check **failed** (server time: {{ .now }})\n\n{{ .FailReason }}"
"strict_tls": true, },
// seconds between checks "fixed": {
"interval": 10, "subject": "I HAVE BEEN FIXED"
// seconds for http timeout }
"timeout": 5, },
// post lag to cachet metric (graph) "interval": 1,
// note either metric ID or component ID are required "timeout": 1,
"metric_id": <metric id>, "threshold": 80,
// post incidents to this component "headers": {
"component_id": <component id>, "Authorization": "Basic <hash>"
// If % of downtime is over this threshold, open an incident },
"threshold": 80, "expected_status_code": 200,
// optional, expected status code (either status code or body must be supplied) "expected_body": "P.*NG"
"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": ""
} }
``` ```
Installation ## Installation
------------
1. Download binary from [release page](https://github.com/CastawayLabs/cachet-monitor/releases) 1. Download binary from [release page](https://github.com/bennetgallein/cachet-monitor/releases)
2. Create your configuration ([example](https://raw.githubusercontent.com/CastawayLabs/cachet-monitor/master/example.config.json)) 2. Add the binary to an executable path (/usr/bin, etc.)
3. `cachet-monitor -c /etc/cachet-monitor.config.json` 3. Create a configuration following provided examples
4. `cachet-monitor -c /etc/cachet-monitor.json`
pro tip: run in background using `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 &`, or use a tmux/screen session
``` ```
Usage of cachet-monitor: Usage:
-c="/etc/cachet-monitor.config.json": Config path cachet-monitor (-c PATH | --config PATH) [--log=LOGPATH] [--name=NAME] [--immediate]
-log="": Log path cachet-monitor -h | --help | --version
-name="": System Name
Arguments:
PATH path to config.json
LOGPATH path to log output (defaults to STDOUT)
NAME name of this logger
Examples:
cachet-monitor -c /root/cachet-monitor.json
cachet-monitor -c /root/cachet-monitor.json --log=/var/log/cachet-monitor.log --name="development machine"
Options:
-c PATH.json --config PATH Path to configuration file
-h --help Show this screen.
--version Show version
--immediate Tick immediately (by default waits for first defined interval)
--restarted Get open incidents before start monitoring (if monitor died or restarted)
Environment varaibles:
CACHET_API override API url from configuration
CACHET_TOKEN override API token from configuration
CACHET_DEV set to enable dev logging
``` ```
Environment variables ## Init script
---------------------
| Name | Example Value | Description | If your system is running systemd (like Debian, Ubuntu 16.04, Fedora, RHEL7, or Archlinux) you can use the provided example file: [example.cachet-monitor.service](https://github.com/bennetgallein/cachet-monitor/blob/master/example.cachet-monitor.service).
| ------------ | ------------------------------ | --------------------------- |
| CACHET_API | http://demo.cachethq.io/api/v1 | URL endpoint for cachet api |
| CACHET_TOKEN | APIToken123 | API Authentication token |
| CACHET_DEV | 1 | Strips logging |
Vision and goals 1. Simply put it in the right place with `cp example.cachet-monitor.service /etc/systemd/system/cachet-monitor.service`
---------------- 2. Then do a `systemctl daemon-reload` in your terminal to update Systemd configuration
3. Finally you can start cachet-monitor on every startup with `systemctl enable cachet-monitor.service`! 👍
## Templates
This package makes use of [`text/template`](https://godoc.org/text/template). [Default HTTP template](https://github.com/CastawayLabs/cachet-monitor/blob/master/http.go#L14)
The following variables are available:
| Root objects | Description |
| ------------- | ----------------------------------- |
| `.SystemName` | system name |
| `.API` | `api` object from configuration |
| `.Monitor` | `monitor` object from configuration |
| `.now` | formatted date string |
| Monitor variables |
| ----------------- |
| `.Name` |
| `.Target` |
| `.Type` |
| `.Strict` |
| `.MetricID` |
| ... |
All monitor variables are available from `monitor.go`
## Monitor Types
We support a variety of monitor-types. Here are the configuration parameters for each of them
Also, the following parameters are shared for all monitors.
| Key | Description |
| ----------------------- | ------------------------------------------------------------------------------ |
| name | a friendly name for the monitor |
| target | target for the check (e.g. a domain or IP) |
| active | a boolean wether or not this test is currently active |
| type | type type of the check, see supported types above or below |
| interval | the interval in seconds in which to check the monitor |
| timeout | the timeout for each check. Needs to be smaller than the interval |
| metric_id | the ID of the metric. Metrics are used for graphing values |
| component_id | the ID of the component inside of Cachet. Used for creating incidents |
| templates.investigating | template to use as a message for when the check enters the investigating stage |
| templates.fixed | template to use as a message for when the check enters the fixed stage |
| threshold | If % of downtime is over this threshold, open an incident |
| threshold_count | the number of checks that count into the threshold (defaults to 10) |
### HTTP
Either expected_body or expected_status_code needs to be set.
| Key | Description |
| -------------------- | ------------------------------------------------------------------------------------------- |
| method | the HTTP Request method to use (Defaults to GET) |
| headers | a key-value array of additional headers to use for the request |
| expected_status_code | the expected status-code returned from the request |
| expected_body | a regex or normal string that will be used to test against the returned body of the request |
| expected_md5sum | a md5 checksum of the body, which will be checked against |
| expected_length | the length of the string of the response body |
| data | body-data for a post request |
### DNS
| Key | Description |
| -------- | ---------------------------------------------------------------------------------------------------- |
| dns | set a custom DNS-Resolver (IP:Port format) |
| question | the type of DNS-Request to execute (e.g. A, MX, CNAME...). Can also be a List (['A', 'MX', 'CNAME']) |
| answers | an array of response objects. see below |
#### Answer Object
| Key | Description |
| ----- | --------------------------------------------------------------------- |
| regex | if you want to use a regexp, use this key and the regexp as the value |
| exact | exact match for the response value |
### TCP
| Key | Description |
| ---- | ---------------------------------- |
| port | the port to do a tcp connection to |
### ICMP
_No special variables needed_
## Vision and goals
We made this tool because we felt the need to have our own monitoring software (leveraging on Cachet). 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. 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. This gives us power to have an army of geographically distributed loggers and reveal issues in both latency & downtime on client websites.
Package usage ## 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. When using `cachet-monitor` as a package in another program, you should follow what `cli/main.go` does. It is important to call `Validate` on `CachetMonitor` and all the monitors inside.
[API Documentation](https://godoc.org/github.com/CastawayLabs/cachet-monitor) [API Documentation](https://godoc.org/github.com/CastawayLabs/cachet-monitor)
## License # Contributions welcome
MIT License We'll happily accept contributions for anything usefull.
Copyright (c) 2016 Castaway Labs LLC # Build on Linux/MacOS
Permission is hereby granted, free of charge, to any person obtaining a copy 1. Read and install with https://ahmadawais.com/install-go-lang-on-macos-with-homebrew/
of this software and associated documentation files (the "Software"), to deal 2. Test in console with `go get -u` and `go build cli/main.go`
in the Software without restriction, including without limitation the rights 3. Run `./go-executable-build.sh cli/main.go`
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell 4. This will create a `build/cli/main.go-linux-amd64`-file, which is the executable binary
copies of the Software, and to permit persons to whom the Software is 5. `mv build/cli/main.go-linux-amd64 /usr/bin/cachet-monitor`
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.

80
slack.go Normal file
View File

@@ -0,0 +1,80 @@
package cachet
import (
"bytes"
"encoding/json"
"errors"
"log"
"net/http"
"time"
)
type Slack struct {
WebhookURL string
Attachments []Attachments `json:"attachments"`
}
type Fields struct {
Title string `json:"title"`
Value string `json:"value"`
Short bool `json:"short"`
}
type Attachments struct {
Fallback string `json:"fallback"`
Color string `json:"color"`
Pretext string `json:"pretext"`
Title string `json:"title"`
TitleLink string `json:"title_link"`
Text string `json:"text"`
Fields []Fields `json:"fields"`
ThumbURL string `json:"thumb_url"`
Footer string `json:"footer"`
FooterIcon string `json:"footer_icon"`
Ts int64 `json:"ts"`
}
func test() {
slack := Slack{
Attachments: []Attachments{
Attachments{
Fallback: "Required plain-text summary of the attachment.",
Color: "#36a64f",
Title: "Slack API Documentation",
TitleLink: "https://status.easyship.com",
Text: "Optional text that appears within the attachment",
Footer: "Cachet Monitor",
FooterIcon: "https://i.imgur.com/spck1w6.png",
Ts: time.Now().Unix(),
},
}}
slack.WebhookURL = "https://hooks.slack.com/services/0000000/00000000/xxxxxxxxxxxxxxxxxxx"
err := slack.SendSlackNotification()
if err != nil {
log.Fatal(err)
}
}
// SendSlackNotification will post to an 'Incoming Webook' url setup in Slack Apps. It accepts
// some text and the slack channel is saved within Slack.
func (slack *Slack) SendSlackNotification() error {
slackBody, _ := json.Marshal(slack)
req, err := http.NewRequest(http.MethodPost, slack.WebhookURL, bytes.NewBuffer(slackBody))
if err != nil {
return err
}
req.Header.Add("Content-Type", "application/json")
client := &http.Client{Timeout: 10 * time.Second}
resp, err := client.Do(req)
if err != nil {
return err
}
buf := new(bytes.Buffer)
buf.ReadFrom(resp.Body)
if buf.String() != "ok" {
return errors.New("Non-ok response returned from Slack")
}
return nil
}

81
tcp.go
View File

@@ -1,15 +1,76 @@
// Thanks go to https://github.com/Soontao/cachet-monitor/blob/master/tcp.go
package cachet package cachet
import (
"fmt"
"net"
"time"
)
// Investigating template
var defaultTCPInvestigatingTpl = MessageTemplate{
Subject: `{{ .Monitor.Name }} - {{ .SystemName }}`,
Message: `{{ .Monitor.Name }} check **failed** (server time: {{ .now }})
{{ .FailReason }}`,
}
// Fixed template
var defaultTCPFixedTpl = MessageTemplate{
Subject: `{{ .Monitor.Name }} - {{ .SystemName }}`,
Message: `**Resolved** - {{ .now }}
Down seconds: {{ .downSeconds }}s`,
}
// TCPMonitor struct
type TCPMonitor struct { type TCPMonitor struct {
AbstractMonitor `mapstructure:",squash"` AbstractMonitor `mapstructure:",squash"`
Port string
// same as output from net.JoinHostPort }
// defaults to parsed config from /etc/resolv.conf when empty
DNSServer string // CheckTCPPortAlive func
func CheckTCPPortAlive(ip, port string, timeout int64) (bool, error) {
// Will be converted to FQDN
Domain string conn, err := net.DialTimeout("tcp", net.JoinHostPort(ip, port), time.Duration(timeout)*time.Second)
Type string if conn != nil {
// expected answers (regex) defer conn.Close()
Expect []string }
if err != nil {
return false, err
} else {
return true, nil
}
}
// test if it available
func (m *TCPMonitor) test() bool {
if alive, e := CheckTCPPortAlive(m.Target, m.Port, int64(m.Timeout)); alive {
return true
} else {
m.lastFailReason = fmt.Sprintf("TCP check failed: %v", e)
return false
}
}
// Validate configuration
func (m *TCPMonitor) Validate() []string {
// set incident temp
m.Template.Investigating.SetDefault(defaultTCPInvestigatingTpl)
m.Template.Fixed.SetDefault(defaultTCPFixedTpl)
// super.Validate()
errs := m.AbstractMonitor.Validate()
if m.Target == "" {
errs = append(errs, "Target is required")
}
if m.Port == "" {
errs = append(errs, "Port is required")
}
return errs
} }