Compare commits

..

1 Commits

Author SHA1 Message Date
IamTheFij
f66276c24f Fix ownership of app directory
This seems to be causing an error on startup.
2019-12-21 08:26:04 -08:00
18 changed files with 129 additions and 325 deletions
+3 -58
View File
@@ -45,70 +45,15 @@ trigger:
- refs/tags/v* - refs/tags/v*
steps: steps:
- name: build all binaries
image: golang:1.12
commands:
- make all
- name: push image - arm # Might consider moving this step into the previous pipeline
- name: push image
image: plugins/docker image: plugins/docker
settings: settings:
repo: iamthefij/minitor-go repo: iamthefij/minitor-go
dockerfile: Dockerfile.multi-stage
auto_tag: true auto_tag: true
auto_tag_suffix: linux-arm
username: username:
from_secret: docker_username from_secret: docker_username
password: password:
from_secret: docker_password from_secret: docker_password
build_args:
- ARCH=arm
- REPO=arm32v7
- name: push image - arm64
image: plugins/docker
settings:
repo: iamthefij/minitor-go
auto_tag: true
auto_tag_suffix: linux-arm64
username:
from_secret: docker_username
password:
from_secret: docker_password
build_args:
- ARCH=arm64
- REPO=arm64v8
- name: push image - amd64
image: plugins/docker
settings:
repo: iamthefij/minitor-go
auto_tag: true
auto_tag_suffix: linux-amd64
username:
from_secret: docker_username
password:
from_secret: docker_password
- name: publish manifest
image: plugins/manifest
settings:
spec: manifest.tmpl
auto_tag: true
ignore_missing: true
username:
from_secret: docker_username
password:
from_secret: docker_password
- name: notify
image: drillster/drone-email
settings:
host:
from_secret: SMTP_HOST
username:
from_secret: SMTP_USER
password:
from_secret: SMTP_PASS
from: drone@iamthefij.com
when:
status: [changed, failure]
Vendored
+1 -3
View File
@@ -16,6 +16,4 @@
config.yml config.yml
# Output binary # Output binary
minitor minitor-go
minitor-linux-*
minitor-darwin-amd64
+5 -9
View File
@@ -1,13 +1,12 @@
ARG REPO=library ARG REPO=library
FROM multiarch/qemu-user-static:4.2.0-2 as qemu-user-static
FROM ${REPO}/alpine:3.10 FROM ${REPO}/alpine:3.10
# Copying all qemu files because amd64 doesn't exist and cannot condional copy
COPY --from=qemu-user-static /usr/bin/qemu-* /usr/bin/
RUN mkdir /app RUN mkdir /app
WORKDIR /app/ WORKDIR /app/
# Copy minitor in
ARG ARCH=amd64
COPY ./minitor-go ./minitor
# Add common checking tools # Add common checking tools
RUN apk --no-cache add bash=~5.0 curl=~7.66 jq=~1.6 RUN apk --no-cache add bash=~5.0 curl=~7.66 jq=~1.6
@@ -16,12 +15,9 @@ RUN addgroup -S minitor && adduser -S minitor -G minitor
# Copy scripts # Copy scripts
COPY ./scripts /app/scripts COPY ./scripts /app/scripts
RUN chown -R minitor:minitor /app
RUN chmod -R 755 /app/scripts RUN chmod -R 755 /app/scripts
# Copy minitor in
ARG ARCH=amd64
COPY ./minitor-linux-${ARCH} ./minitor
# Drop to non-root user # Drop to non-root user
USER minitor USER minitor
+1
View File
@@ -31,6 +31,7 @@ RUN addgroup -S minitor && adduser -S minitor -G minitor
# Copy scripts # Copy scripts
COPY ./scripts /app/scripts COPY ./scripts /app/scripts
RUN chown -R minitor:minitor /app
RUN chmod -R 755 /app/scripts RUN chmod -R 755 /app/scripts
# Drop to non-root user # Drop to non-root user
+11 -59
View File
@@ -1,28 +1,23 @@
DOCKER_TAG ?= minitor-go-${USER}
GIT_TAG_NAME := $(shell git tag -l --contains HEAD)
GIT_SHA := $(shell git rev-parse HEAD)
VERSION := $(if $(GIT_TAG_NAME),$(GIT_TAG_NAME),$(GIT_SHA))
.PHONY: all .PHONY: all
all: minitor-linux-amd64 minitor-linux-arm minitor-linux-arm64 DOCKER_TAG ?= minitor-go-${USER}
.PHONY: default .PHONY: default
default: test default: test
.PHONY: build .PHONY: build
build: minitor build:
go build
minitor: minitor-go:
@echo Version: $(VERSION) go build
go build -ldflags '-X "main.version=${VERSION}"' -o minitor
.PHONY: run .PHONY: run
run: minitor build run: minitor-go build
./minitor -debug ./minitor-go -debug
.PHONY: run-metrics .PHONY: run-metrics
run-metrics: minitor build run-metrics: minitor-go build
./minitor -debug -metrics ./minitor-go -debug -metrics
.PHONY: test .PHONY: test
test: test:
@@ -46,56 +41,13 @@ check:
.PHONY: clean .PHONY: clean
clean: clean:
rm -f ./minitor rm -f ./minitor-go
rm -f ./minitor-linux-*
rm -f ./minitor-darwin-amd64
rm -f ./coverage.out rm -f ./coverage.out
.PHONY: docker-build .PHONY: docker-build
docker-build: docker-build:
docker build -f ./Dockerfile.multi-stage -t $(DOCKER_TAG)-linux-amd64 . docker build -f ./Dockerfile.multi-stage -t $(DOCKER_TAG) .
.PHONY: docker-run .PHONY: docker-run
docker-run: docker-build docker-run: docker-build
docker run --rm -v $(shell pwd)/config.yml:/root/config.yml $(DOCKER_TAG) docker run --rm -v $(shell pwd)/config.yml:/root/config.yml $(DOCKER_TAG)
## Multi-arch targets
# Arch specific go build targets
minitor-darwin-amd64:
GOOS=darwin GOARCH=amd64 CGO_ENABLED=0 \
go build -ldflags '-X "main.version=${VERSION}"' -a -installsuffix nocgo \
-o minitor-darwin-amd64
minitor-linux-amd64:
GOOS=linux GOARCH=amd64 CGO_ENABLED=0 \
go build -ldflags '-X "main.version=${VERSION}"' -a -installsuffix nocgo \
-o minitor-linux-amd64
minitor-linux-arm:
GOOS=linux GOARCH=arm CGO_ENABLED=0 \
go build -ldflags '-X "main.version=${VERSION}"' -a -installsuffix nocgo \
-o minitor-linux-arm
minitor-linux-arm64:
GOOS=linux GOARCH=arm64 CGO_ENABLED=0 \
go build -ldflags '-X "main.version=${VERSION}"' -a -installsuffix nocgo \
-o minitor-linux-arm64
# Arch specific docker build targets
.PHONY: docker-build-arm
docker-build-arm: minitor-linux-arm
docker build --build-arg REPO=arm32v7 --build-arg ARCH=arm . -t ${DOCKER_TAG}-linux-arm
.PHONY: docker-build-arm
docker-build-arm64: minitor-linux-arm64
docker build --build-arg REPO=arm64v8 --build-arg ARCH=arm64 . -t ${DOCKER_TAG}-linux-arm64
# Cross run on host architechture
.PHONY: docker-run-arm
docker-run-arm: docker-build-arm
docker run --rm -v /var/run/docker.sock:/var/run/docker.sock --name $(DOCKER_TAG)-run ${DOCKER_TAG}-linux-arm
.PHONY: docker-run-arm64
docker-run-arm64: docker-build-arm64
docker run --rm -v /var/run/docker.sock:/var/run/docker.sock --name $(DOCKER_TAG)-run ${DOCKER_TAG}-linux-arm64
+28 -8
View File
@@ -1,6 +1,6 @@
# minitor-go # minitor-go
A reimplementation of [Minitor](https://git.iamthefij.com/iamthefij/minitor) in Go A reimplementation of [Minitor](https://git.iamthefij/iamthefij/minitor) in Go
Minitor is already a minimal monitoring tool. Python 3 was a quick way to get something live, but Python itself comes with a large footprint. Thus Go feels like a better fit for the project, longer term. Minitor is already a minimal monitoring tool. Python 3 was a quick way to get something live, but Python itself comes with a large footprint. Thus Go feels like a better fit for the project, longer term.
@@ -8,8 +8,29 @@ Initial target is meant to be roughly compatible requiring only minor changes to
## Differences from Python version ## Differences from Python version
There are a few key differences between the Python version and the v0.x Go version.
Templating for Alert messages has been updated. In the Python version, `str.format(...)` was used with certain keys passed in that could be used to format messages. In the Go version, we use a struct, `AlertNotice` defined in `alert.go` and the built in Go templating format. Eg. First, configuration keys cannot have multiple types in Go, so a different key must be used when specifying a Shell command as a string rather than a list of args. Instead of `command`, you must use `command_shell`. Eg:
minitor-py:
```yaml
monitors:
- name: Exec command
command: ['echo', 'test']
- name: Shell command
command: echo 'test'
```
minitor-go:
```yaml
monitors:
- name: Exec command
command: ['echo', 'test']
- name: Shell command
command_shell: echo 'test'
```
Second, templating for Alert messages has been updated. In the Python version, `str.format(...)` was used with certain keys passed in that could be used to format messages. In the Go version, we use a struct, `AlertNotice` defined in `alert.go` and the built in Go templating format. Eg.
minitor-py: minitor-py:
```yaml ```yaml
@@ -17,7 +38,7 @@ alerts:
log_command: log_command:
command: ['echo', '{monitor_name}'] command: ['echo', '{monitor_name}']
log_shell: log_shell:
command: 'echo {monitor_name}' command_shell: 'echo {monitor_name}'
``` ```
minitor-go: minitor-go:
@@ -26,7 +47,7 @@ alerts:
log_command: log_command:
command: ['echo', '{{.MonitorName}}'] command: ['echo', '{{.MonitorName}}']
log_shell: log_shell:
command: 'echo {{.MonitorName}}' command_shell: 'echo {{.MonitorName}}'
``` ```
Finally, newlines in a shell command don't terminate a particular command. Semicolons must be used and continuations should not. Finally, newlines in a shell command don't terminate a particular command. Semicolons must be used and continuations should not.
@@ -35,7 +56,7 @@ minitor-py:
```yaml ```yaml
alerts: alerts:
log_shell: log_shell:
command: > command_shell: >
echo "line 1" echo "line 1"
echo "line 2" echo "line 2"
echo "continued" \ echo "continued" \
@@ -46,7 +67,7 @@ minitor-go:
```yaml ```yaml
alerts: alerts:
log_shell: log_shell:
command: > command_shell: >
echo "line 1"; echo "line 1";
echo "line 2"; echo "line 2";
echo "continued" echo "continued"
@@ -65,8 +86,7 @@ Pairity:
- [x] Allow templating of alert commands - [x] Allow templating of alert commands
- [x] Implement Prometheus client to export metrics - [x] Implement Prometheus client to export metrics
- [x] Test coverage - [x] Test coverage
- [x] Integration testing (manual or otherwise) - [ ] Integration testing (manual or otherwise)
- [x] Allow commands and shell commands in the same config key
Improvement (potentially breaking): Improvement (potentially breaking):
+9 -6
View File
@@ -12,7 +12,8 @@ import (
// Alert is a config driven mechanism for sending a notice // Alert is a config driven mechanism for sending a notice
type Alert struct { type Alert struct {
Name string Name string
Command CommandOrShell Command []string
CommandShell string `yaml:"command_shell"`
commandTemplate []*template.Template commandTemplate []*template.Template
commandShellTemplate *template.Template commandShellTemplate *template.Template
} }
@@ -30,7 +31,9 @@ type AlertNotice struct {
// IsValid returns a boolean indicating if the Alert has been correctly // IsValid returns a boolean indicating if the Alert has been correctly
// configured // configured
func (alert Alert) IsValid() bool { func (alert Alert) IsValid() bool {
return !alert.Command.Empty() atLeastOneCommand := (alert.CommandShell != "" || alert.Command != nil)
atMostOneCommand := (alert.CommandShell == "" || alert.Command == nil)
return atLeastOneCommand && atMostOneCommand
} }
// BuildTemplates compiles command templates for the Alert // BuildTemplates compiles command templates for the Alert
@@ -38,16 +41,16 @@ func (alert *Alert) BuildTemplates() error {
if LogDebug { if LogDebug {
log.Printf("DEBUG: Building template for alert %s", alert.Name) log.Printf("DEBUG: Building template for alert %s", alert.Name)
} }
if alert.commandTemplate == nil && alert.Command.Command != nil { if alert.commandTemplate == nil && alert.Command != nil {
alert.commandTemplate = []*template.Template{} alert.commandTemplate = []*template.Template{}
for i, cmdPart := range alert.Command.Command { for i, cmdPart := range alert.Command {
alert.commandTemplate = append(alert.commandTemplate, template.Must( alert.commandTemplate = append(alert.commandTemplate, template.Must(
template.New(alert.Name+string(i)).Parse(cmdPart), template.New(alert.Name+string(i)).Parse(cmdPart),
)) ))
} }
} else if alert.commandShellTemplate == nil && alert.Command.ShellCommand != "" { } else if alert.commandShellTemplate == nil && alert.CommandShell != "" {
alert.commandShellTemplate = template.Must( alert.commandShellTemplate = template.Must(
template.New(alert.Name).Parse(alert.Command.ShellCommand), template.New(alert.Name).Parse(alert.CommandShell),
) )
} else { } else {
return fmt.Errorf("No template provided for alert %s", alert.Name) return fmt.Errorf("No template provided for alert %s", alert.Name)
+13 -8
View File
@@ -11,9 +11,14 @@ func TestAlertIsValid(t *testing.T) {
expected bool expected bool
name string name string
}{ }{
{Alert{Command: CommandOrShell{Command: []string{"echo", "test"}}}, true, "Command only"}, {Alert{Command: []string{"echo", "test"}}, true, "Command only"},
{Alert{Command: CommandOrShell{ShellCommand: "echo test"}}, true, "CommandShell only"}, {Alert{CommandShell: "echo test"}, true, "CommandShell only"},
{Alert{}, false, "No commands"}, {Alert{}, false, "No commands"},
{
Alert{Command: []string{"echo", "test"}, CommandShell: "echo test"},
false,
"Both commands",
},
} }
for _, c := range cases { for _, c := range cases {
@@ -36,28 +41,28 @@ func TestAlertSend(t *testing.T) {
name string name string
}{ }{
{ {
Alert{Command: CommandOrShell{Command: []string{"echo", "{{.MonitorName}}"}}}, Alert{Command: []string{"echo", "{{.MonitorName}}"}},
AlertNotice{MonitorName: "test"}, AlertNotice{MonitorName: "test"},
"test\n", "test\n",
false, false,
"Command with template", "Command with template",
}, },
{ {
Alert{Command: CommandOrShell{ShellCommand: "echo {{.MonitorName}}"}}, Alert{CommandShell: "echo {{.MonitorName}}"},
AlertNotice{MonitorName: "test"}, AlertNotice{MonitorName: "test"},
"test\n", "test\n",
false, false,
"Command shell with template", "Command shell with template",
}, },
{ {
Alert{Command: CommandOrShell{Command: []string{"echo", "{{.Bad}}"}}}, Alert{Command: []string{"echo", "{{.Bad}}"}},
AlertNotice{MonitorName: "test"}, AlertNotice{MonitorName: "test"},
"", "",
true, true,
"Command with bad template", "Command with bad template",
}, },
{ {
Alert{Command: CommandOrShell{ShellCommand: "echo {{.Bad}}"}}, Alert{CommandShell: "echo {{.Bad}}"},
AlertNotice{MonitorName: "test"}, AlertNotice{MonitorName: "test"},
"", "",
true, true,
@@ -98,8 +103,8 @@ func TestAlertBuildTemplate(t *testing.T) {
expectErr bool expectErr bool
name string name string
}{ }{
{Alert{Command: CommandOrShell{Command: []string{"echo", "test"}}}, false, "Command only"}, {Alert{Command: []string{"echo", "test"}}, false, "Command only"},
{Alert{Command: CommandOrShell{ShellCommand: "echo test"}}, false, "CommandShell only"}, {Alert{CommandShell: "echo test"}, false, "CommandShell only"},
{Alert{}, true, "No commands"}, {Alert{}, true, "No commands"},
} }
+4 -32
View File
@@ -4,6 +4,7 @@ import (
"errors" "errors"
"io/ioutil" "io/ioutil"
"log" "log"
"os"
"gopkg.in/yaml.v2" "gopkg.in/yaml.v2"
) )
@@ -15,37 +16,6 @@ type Config struct {
Alerts map[string]*Alert Alerts map[string]*Alert
} }
// CommandOrShell type wraps a string or list of strings
// for executing a command directly or in a shell
type CommandOrShell struct {
ShellCommand string
Command []string
}
// Empty checks if the Command has a value
func (cos CommandOrShell) Empty() bool {
return (cos.ShellCommand == "" && cos.Command == nil)
}
// UnmarshalYAML allows unmarshalling either a string or slice of strings
// and parsing them as either a command or a shell command.
func (cos *CommandOrShell) UnmarshalYAML(unmarshal func(interface{}) error) error {
var cmd []string
err := unmarshal(&cmd)
// Error indicates this is shell command
if err != nil {
var shellCmd string
err := unmarshal(&shellCmd)
if err != nil {
return err
}
cos.ShellCommand = shellCmd
} else {
cos.Command = cmd
}
return nil
}
// IsValid checks config validity and returns true if valid // IsValid checks config validity and returns true if valid
func (config Config) IsValid() (isValid bool) { func (config Config) IsValid() (isValid bool) {
isValid = true isValid = true
@@ -108,7 +78,9 @@ func LoadConfig(filePath string) (config Config, err error) {
return return
} }
err = yaml.Unmarshal(data, &config) // TODO: Decide if this is better expanded here, or only when executing
envExpanded := os.ExpandEnv(string(data))
err = yaml.Unmarshal([]byte(envExpanded), &config)
if err != nil { if err != nil {
return return
} }
+1 -66
View File
@@ -23,74 +23,9 @@ func TestLoadConfig(t *testing.T) {
_, err := LoadConfig(c.configPath) _, err := LoadConfig(c.configPath)
hasErr := (err != nil) hasErr := (err != nil)
if hasErr != c.expectErr { if hasErr != c.expectErr {
t.Errorf("LoadConfig(%v), expected_error=%v actual=%v", c.name, c.expectErr, err) t.Errorf("LoadConfig(%v), expected=%v actual=%v", c.name, "Err", err)
log.Printf("Case failed: %s", c.name) log.Printf("Case failed: %s", c.name)
} }
log.Println("-----") log.Println("-----")
} }
} }
// TestMultiLineConfig is a more complicated test stepping through the parsing
// and execution of mutli-line strings presented in YAML
func TestMultiLineConfig(t *testing.T) {
log.Println("Testing multi-line string config")
config, err := LoadConfig("./test/valid-verify-multi-line.yml")
if err != nil {
t.Fatalf("TestMultiLineConfig(load), expected=no_error actual=%v", err)
}
log.Println("-----")
log.Println("TestMultiLineConfig(parse > string)")
expected := "echo 'Some string with stuff'; echo \"<angle brackets>\"; exit 1\n"
actual := config.Monitors[0].Command.ShellCommand
if expected != actual {
t.Errorf("TestMultiLineConfig(>) failed")
t.Logf("string expected=`%v`", expected)
t.Logf("string actual =`%v`", actual)
t.Logf("bytes expected=%v", []byte(expected))
t.Logf("bytes actual =%v", []byte(actual))
}
log.Println("-----")
log.Println("TestMultiLineConfig(execute > string)")
_, notice := config.Monitors[0].Check()
if notice == nil {
t.Fatalf("Did not receive an alert notice")
}
expected = "Some string with stuff\n<angle brackets>\n"
actual = notice.LastCheckOutput
if expected != actual {
t.Errorf("TestMultiLineConfig(execute > string) check failed")
t.Logf("string expected=`%v`", expected)
t.Logf("string actual =`%v`", actual)
t.Logf("bytes expected=%v", []byte(expected))
t.Logf("bytes actual =%v", []byte(actual))
}
log.Println("-----")
log.Println("TestMultiLineConfig(parse | string)")
expected = "echo 'Some string with stuff'\necho '<angle brackets>'\n"
actual = config.Alerts["log_shell"].Command.ShellCommand
if expected != actual {
t.Errorf("TestMultiLineConfig(|) failed")
t.Logf("string expected=`%v`", expected)
t.Logf("string actual =`%v`", actual)
t.Logf("bytes expected=%v", []byte(expected))
t.Logf("bytes actual =%v", []byte(actual))
}
log.Println("-----")
log.Println("TestMultiLineConfig(execute | string)")
actual, err = config.Alerts["log_shell"].Send(AlertNotice{})
if err != nil {
t.Errorf("Execution of alert failed")
}
expected = "Some string with stuff\n<angle brackets>\n"
if expected != actual {
t.Errorf("TestMultiLineConfig(execute | string) check failed")
t.Logf("string expected=`%v`", expected)
t.Logf("string actual =`%v`", actual)
t.Logf("bytes expected=%v", []byte(expected))
t.Logf("bytes actual =%v", []byte(actual))
}
}
+9 -9
View File
@@ -18,7 +18,7 @@ func TestCheckMonitors(t *testing.T) {
Monitors: []*Monitor{ Monitors: []*Monitor{
&Monitor{ &Monitor{
Name: "Success", Name: "Success",
Command: CommandOrShell{Command: []string{"true"}}, Command: []string{"true"},
}, },
}, },
}, },
@@ -30,12 +30,12 @@ func TestCheckMonitors(t *testing.T) {
Monitors: []*Monitor{ Monitors: []*Monitor{
&Monitor{ &Monitor{
Name: "Failure", Name: "Failure",
Command: CommandOrShell{Command: []string{"false"}}, Command: []string{"false"},
AlertAfter: 1, AlertAfter: 1,
}, },
&Monitor{ &Monitor{
Name: "Failure", Name: "Failure",
Command: CommandOrShell{Command: []string{"false"}}, Command: []string{"false"},
AlertDown: []string{"unknown"}, AlertDown: []string{"unknown"},
AlertAfter: 1, AlertAfter: 1,
}, },
@@ -49,12 +49,12 @@ func TestCheckMonitors(t *testing.T) {
Monitors: []*Monitor{ Monitors: []*Monitor{
&Monitor{ &Monitor{
Name: "Success", Name: "Success",
Command: CommandOrShell{Command: []string{"ls"}}, Command: []string{"ls"},
alertCount: 1, alertCount: 1,
}, },
&Monitor{ &Monitor{
Name: "Success", Name: "Success",
Command: CommandOrShell{Command: []string{"true"}}, Command: []string{"true"},
AlertUp: []string{"unknown"}, AlertUp: []string{"unknown"},
alertCount: 1, alertCount: 1,
}, },
@@ -68,14 +68,14 @@ func TestCheckMonitors(t *testing.T) {
Monitors: []*Monitor{ Monitors: []*Monitor{
&Monitor{ &Monitor{
Name: "Failure", Name: "Failure",
Command: CommandOrShell{Command: []string{"false"}}, Command: []string{"false"},
AlertDown: []string{"good"}, AlertDown: []string{"good"},
AlertAfter: 1, AlertAfter: 1,
}, },
}, },
Alerts: map[string]*Alert{ Alerts: map[string]*Alert{
"good": &Alert{ "good": &Alert{
Command: CommandOrShell{Command: []string{"true"}}, Command: []string{"true"},
}, },
}, },
}, },
@@ -87,7 +87,7 @@ func TestCheckMonitors(t *testing.T) {
Monitors: []*Monitor{ Monitors: []*Monitor{
&Monitor{ &Monitor{
Name: "Failure", Name: "Failure",
Command: CommandOrShell{Command: []string{"false"}}, Command: []string{"false"},
AlertDown: []string{"bad"}, AlertDown: []string{"bad"},
AlertAfter: 1, AlertAfter: 1,
}, },
@@ -95,7 +95,7 @@ func TestCheckMonitors(t *testing.T) {
Alerts: map[string]*Alert{ Alerts: map[string]*Alert{
"bad": &Alert{ "bad": &Alert{
Name: "bad", Name: "bad",
Command: CommandOrShell{Command: []string{"false"}}, Command: []string{"false"},
}, },
}, },
}, },
-25
View File
@@ -1,25 +0,0 @@
image: iamthefij/minitor-go:{{#if build.tag}}{{trimPrefix "v" build.tag}}{{else}}latest{{/if}}
{{#if build.tags}}
tags:
{{#each build.tags}}
- {{this}}
{{/each}}
{{/if}}
manifests:
-
image: iamthefij/minitor-go:{{#if build.tag}}{{trimPrefix "v" build.tag}}-{{/if}}linux-amd64
platform:
architecture: amd64
os: linux
-
image: iamthefij/minitor-go:{{#if build.tag}}{{trimPrefix "v" build.tag}}-{{/if}}linux-arm64
platform:
architecture: arm64
os: linux
variant: v8
-
image: iamthefij/minitor-go:{{#if build.tag}}{{trimPrefix "v" build.tag}}-{{/if}}linux-arm
platform:
architecture: arm
os: linux
variant: v7
+13 -7
View File
@@ -11,7 +11,8 @@ import (
type Monitor struct { type Monitor struct {
// Config values // Config values
Name string Name string
Command CommandOrShell Command []string
CommandShell string `yaml:"command_shell"`
AlertDown []string `yaml:"alert_down"` AlertDown []string `yaml:"alert_down"`
AlertUp []string `yaml:"alert_up"` AlertUp []string `yaml:"alert_up"`
CheckInterval float64 `yaml:"check_interval"` CheckInterval float64 `yaml:"check_interval"`
@@ -28,7 +29,10 @@ type Monitor struct {
// IsValid returns a boolean indicating if the Monitor has been correctly // IsValid returns a boolean indicating if the Monitor has been correctly
// configured // configured
func (monitor Monitor) IsValid() bool { func (monitor Monitor) IsValid() bool {
return (!monitor.Command.Empty() && atLeastOneCommand := (monitor.CommandShell != "" || monitor.Command != nil)
atMostOneCommand := (monitor.CommandShell == "" || monitor.Command == nil)
return (atLeastOneCommand &&
atMostOneCommand &&
monitor.getAlertAfter() > 0 && monitor.getAlertAfter() > 0 &&
monitor.AlertDown != nil) monitor.AlertDown != nil)
} }
@@ -48,10 +52,10 @@ func (monitor Monitor) ShouldCheck() bool {
// and a possible AlertNotice // and a possible AlertNotice
func (monitor *Monitor) Check() (bool, *AlertNotice) { func (monitor *Monitor) Check() (bool, *AlertNotice) {
var cmd *exec.Cmd var cmd *exec.Cmd
if monitor.Command.Command != nil { if monitor.Command != nil {
cmd = exec.Command(monitor.Command.Command[0], monitor.Command.Command[1:]...) cmd = exec.Command(monitor.Command[0], monitor.Command[1:]...)
} else { } else {
cmd = ShellCommand(monitor.Command.ShellCommand) cmd = ShellCommand(monitor.CommandShell)
} }
output, err := cmd.CombinedOutput() output, err := cmd.CombinedOutput()
@@ -151,16 +155,18 @@ func (monitor Monitor) getAlertAfter() int16 {
// Zero is one! // Zero is one!
if monitor.AlertAfter == 0 { if monitor.AlertAfter == 0 {
return 1 return 1
} else {
return monitor.AlertAfter
} }
return monitor.AlertAfter
} }
// GetAlertNames gives a list of alert names for a given monitor status // GetAlertNames gives a list of alert names for a given monitor status
func (monitor Monitor) GetAlertNames(up bool) []string { func (monitor Monitor) GetAlertNames(up bool) []string {
if up { if up {
return monitor.AlertUp return monitor.AlertUp
} else {
return monitor.AlertDown
} }
return monitor.AlertDown
} }
func (monitor Monitor) createAlertNotice(isUp bool) *AlertNotice { func (monitor Monitor) createAlertNotice(isUp bool) *AlertNotice {
+13 -8
View File
@@ -13,11 +13,16 @@ func TestMonitorIsValid(t *testing.T) {
expected bool expected bool
name string name string
}{ }{
{Monitor{Command: CommandOrShell{Command: []string{"echo", "test"}}, AlertDown: []string{"log"}}, true, "Command only"}, {Monitor{Command: []string{"echo", "test"}, AlertDown: []string{"log"}}, true, "Command only"},
{Monitor{Command: CommandOrShell{ShellCommand: "echo test"}, AlertDown: []string{"log"}}, true, "CommandShell only"}, {Monitor{CommandShell: "echo test", AlertDown: []string{"log"}}, true, "CommandShell only"},
{Monitor{Command: CommandOrShell{Command: []string{"echo", "test"}}}, false, "No AlertDown"}, {Monitor{Command: []string{"echo", "test"}}, false, "No AlertDown"},
{Monitor{AlertDown: []string{"log"}}, false, "No commands"}, {Monitor{AlertDown: []string{"log"}}, false, "No commands"},
{Monitor{Command: CommandOrShell{Command: []string{"echo", "test"}}, AlertDown: []string{"log"}, AlertAfter: -1}, false, "Invalid alert threshold, -1"}, {
Monitor{Command: []string{"echo", "test"}, CommandShell: "echo test", AlertDown: []string{"log"}},
false,
"Both commands",
},
{Monitor{Command: []string{"echo", "test"}, AlertDown: []string{"log"}, AlertAfter: -1}, false, "Invalid alert threshold, -1"},
} }
for _, c := range cases { for _, c := range cases {
@@ -249,22 +254,22 @@ func TestMonitorCheck(t *testing.T) {
name string name string
}{ }{
{ {
Monitor{Command: CommandOrShell{Command: []string{"echo", "success"}}}, Monitor{Command: []string{"echo", "success"}},
expected{isSuccess: true, hasNotice: false, lastOutput: "success\n"}, expected{isSuccess: true, hasNotice: false, lastOutput: "success\n"},
"Test successful command", "Test successful command",
}, },
{ {
Monitor{Command: CommandOrShell{ShellCommand: "echo success"}}, Monitor{CommandShell: "echo success"},
expected{isSuccess: true, hasNotice: false, lastOutput: "success\n"}, expected{isSuccess: true, hasNotice: false, lastOutput: "success\n"},
"Test successful command shell", "Test successful command shell",
}, },
{ {
Monitor{Command: CommandOrShell{Command: []string{"total", "failure"}}}, Monitor{Command: []string{"total", "failure"}},
expected{isSuccess: false, hasNotice: true, lastOutput: ""}, expected{isSuccess: false, hasNotice: true, lastOutput: ""},
"Test failed command", "Test failed command",
}, },
{ {
Monitor{Command: CommandOrShell{ShellCommand: "false"}}, Monitor{CommandShell: "false"},
expected{isSuccess: false, hasNotice: true, lastOutput: ""}, expected{isSuccess: false, hasNotice: true, lastOutput: ""},
"Test failed command shell", "Test failed command shell",
}, },
+2 -2
View File
@@ -25,7 +25,7 @@ alerts:
email_up: email_up:
command: [sendmail, "me@minitor.mon", "Recovered: {monitor_name}", "We're back!"] command: [sendmail, "me@minitor.mon", "Recovered: {monitor_name}", "We're back!"]
mailgun_down: mailgun_down:
command: > command_shell: >
curl -s -X POST curl -s -X POST
-F subject="Alert! {{.MonitorName}} failed" -F subject="Alert! {{.MonitorName}} failed"
-F from="Minitor <minitor@minitor.mon>" -F from="Minitor <minitor@minitor.mon>"
@@ -34,7 +34,7 @@ alerts:
https://api.mailgun.net/v3/minitor.mon/messages https://api.mailgun.net/v3/minitor.mon/messages
-u "api:${MAILGUN_API_KEY}" -u "api:${MAILGUN_API_KEY}"
sms_down: sms_down:
command: > command_shell: >
curl -s -X POST -F "Body=Failure! {{.MonitorName}} has failed" curl -s -X POST -F "Body=Failure! {{.MonitorName}} has failed"
-F "From=${AVAILABLE_NUMBER}" -F "To=${MY_PHONE}" -F "From=${AVAILABLE_NUMBER}" -F "To=${MY_PHONE}"
"https://api.twilio.com/2010-04-01/Accounts/${ACCOUNT_SID}/Messages" "https://api.twilio.com/2010-04-01/Accounts/${ACCOUNT_SID}/Messages"
+5 -6
View File
@@ -1,23 +1,22 @@
---
check_interval: 1 check_interval: 1
monitors: monitors:
- name: Command - name: Command
command: ['echo', '$PATH'] command: ['echo', '$PATH']
alert_down: ['log_command', 'log_shell'] alert_down: [ 'log_command', 'log_shell' ]
alert_every: 0 alert_every: 0
- name: Shell - name: Shell
command: > command_shell: >
echo 'Some string with stuff'; echo 'Some string with stuff';
echo 'another line'; echo 'another line';
echo $PATH; echo $PATH;
exit 1 exit 1
alert_down: ['log_command', 'log_shell'] alert_down: [ 'log_command', 'log_shell' ]
alert_after: 5 alert_after: 5
alert_every: 0 alert_every: 0
alerts: alerts:
log_command: log_command:
command: ['echo', 'regular', '"command!!!"', "{{.MonitorName}}"] command: [ 'echo', 'regular', '"command!!!"', "{{.MonitorName}}" ]
log_shell: log_shell:
command: echo "Failure on {{.MonitorName}} User is $USER" command_shell: echo "Failure on {{.MonitorName}} User is $USER"
-18
View File
@@ -1,18 +0,0 @@
---
check_interval: 1
monitors:
- name: Shell
command: >
echo 'Some string with stuff';
echo "<angle brackets>";
exit 1
alert_down: ['log_shell']
alert_after: 1
alert_every: 0
alerts:
log_shell:
command: |
echo 'Some string with stuff'
echo '<angle brackets>'
+11 -1
View File
@@ -5,9 +5,19 @@ import (
"strings" "strings"
) )
// escapeCommandShell accepts a command to be executed by a shell and escapes it
func escapeCommandShell(command string) string {
// Remove extra spaces and newlines from ends
command = strings.TrimSpace(command)
// TODO: Not sure if this part is actually needed. Should verify
// Escape double quotes since this will be passed in as an argument
command = strings.Replace(command, `"`, `\"`, -1)
return command
}
// ShellCommand takes a string and executes it as a command using `sh` // ShellCommand takes a string and executes it as a command using `sh`
func ShellCommand(command string) *exec.Cmd { func ShellCommand(command string) *exec.Cmd {
shellCommand := []string{"sh", "-c", strings.TrimSpace(command)} shellCommand := []string{"sh", "-c", escapeCommandShell(command)}
//log.Printf("Shell command: %v", shellCommand) //log.Printf("Shell command: %v", shellCommand)
return exec.Command(shellCommand[0], shellCommand[1:]...) return exec.Command(shellCommand[0], shellCommand[1:]...)
} }