Breaking: Remove python compat flag
This commit is contained in:
parent
c75302bdb8
commit
f3f7c215a7
@ -158,7 +158,7 @@ minitor-go:
|
|||||||
check_interval: 1m30s
|
check_interval: 1m30s
|
||||||
```
|
```
|
||||||
|
|
||||||
For the time being, legacy configs for the Python version of Minitor should be compatible if you apply the `-py-compat` flag when running Minitor. Eventually, this flag will go away when later breaking changes are introduced.
|
The `-py-compat` flag has been removed. Any existing Python oriented configuration needs to be migrated to the new templates.
|
||||||
|
|
||||||
## Future
|
## Future
|
||||||
|
|
||||||
|
19
alert.go
19
alert.go
@ -5,7 +5,6 @@ import (
|
|||||||
"errors"
|
"errors"
|
||||||
"fmt"
|
"fmt"
|
||||||
"os/exec"
|
"os/exec"
|
||||||
"strings"
|
|
||||||
"text/template"
|
"text/template"
|
||||||
"time"
|
"time"
|
||||||
|
|
||||||
@ -45,26 +44,12 @@ func (alert Alert) IsValid() bool {
|
|||||||
|
|
||||||
// BuildTemplates compiles command templates for the Alert
|
// BuildTemplates compiles command templates for the Alert
|
||||||
func (alert *Alert) BuildTemplates() error {
|
func (alert *Alert) BuildTemplates() error {
|
||||||
// TODO: Remove legacy template support later after 1.0
|
|
||||||
legacy := strings.NewReplacer(
|
|
||||||
"{alert_count}", "{{.AlertCount}}",
|
|
||||||
"{alert_message}", "{{.MonitorName}} check has failed {{.FailureCount}} times",
|
|
||||||
"{failure_count}", "{{.FailureCount}}",
|
|
||||||
"{last_output}", "{{.LastCheckOutput}}",
|
|
||||||
"{last_success}", "{{.LastSuccess}}",
|
|
||||||
"{monitor_name}", "{{.MonitorName}}",
|
|
||||||
)
|
|
||||||
|
|
||||||
slog.Debugf("Building template for alert %s", alert.Name)
|
slog.Debugf("Building template for alert %s", alert.Name)
|
||||||
|
|
||||||
switch {
|
switch {
|
||||||
case alert.commandTemplate == nil && alert.Command.Command != nil:
|
case alert.commandTemplate == nil && alert.Command.Command != nil:
|
||||||
alert.commandTemplate = []*template.Template{}
|
alert.commandTemplate = []*template.Template{}
|
||||||
for i, cmdPart := range alert.Command.Command {
|
for i, cmdPart := range alert.Command.Command {
|
||||||
if PyCompat {
|
|
||||||
cmdPart = legacy.Replace(cmdPart)
|
|
||||||
}
|
|
||||||
|
|
||||||
alert.commandTemplate = append(alert.commandTemplate, template.Must(
|
alert.commandTemplate = append(alert.commandTemplate, template.Must(
|
||||||
template.New(alert.Name+fmt.Sprint(i)).Parse(cmdPart),
|
template.New(alert.Name+fmt.Sprint(i)).Parse(cmdPart),
|
||||||
))
|
))
|
||||||
@ -72,10 +57,6 @@ func (alert *Alert) BuildTemplates() error {
|
|||||||
case alert.commandShellTemplate == nil && alert.Command.ShellCommand != "":
|
case alert.commandShellTemplate == nil && alert.Command.ShellCommand != "":
|
||||||
shellCmd := alert.Command.ShellCommand
|
shellCmd := alert.Command.ShellCommand
|
||||||
|
|
||||||
if PyCompat {
|
|
||||||
shellCmd = legacy.Replace(shellCmd)
|
|
||||||
}
|
|
||||||
|
|
||||||
alert.commandShellTemplate = template.Must(
|
alert.commandShellTemplate = template.Must(
|
||||||
template.New(alert.Name).Parse(shellCmd),
|
template.New(alert.Name).Parse(shellCmd),
|
||||||
)
|
)
|
||||||
|
@ -100,8 +100,6 @@ func TestAlertSend(t *testing.T) {
|
|||||||
|
|
||||||
for _, c := range cases {
|
for _, c := range cases {
|
||||||
log.Printf("Testing case %s", c.name)
|
log.Printf("Testing case %s", c.name)
|
||||||
// Set PyCompat to value of compat flag
|
|
||||||
PyCompat = c.pyCompat
|
|
||||||
|
|
||||||
err := c.alert.BuildTemplates()
|
err := c.alert.BuildTemplates()
|
||||||
if err != nil {
|
if err != nil {
|
||||||
@ -121,9 +119,6 @@ func TestAlertSend(t *testing.T) {
|
|||||||
log.Printf("Case failed: %s", c.name)
|
log.Printf("Case failed: %s", c.name)
|
||||||
}
|
}
|
||||||
|
|
||||||
// Set PyCompat back to default value
|
|
||||||
PyCompat = false
|
|
||||||
|
|
||||||
log.Println("-----")
|
log.Println("-----")
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
12
config.go
12
config.go
@ -182,18 +182,6 @@ func LoadConfig(filePath string) (config Config, err error) {
|
|||||||
|
|
||||||
slog.Debugf("Config values:\n%v\n", config)
|
slog.Debugf("Config values:\n%v\n", config)
|
||||||
|
|
||||||
// Add log alert if not present
|
|
||||||
if PyCompat {
|
|
||||||
// Initialize alerts list if not present
|
|
||||||
if config.Alerts == nil {
|
|
||||||
config.Alerts = map[string]*Alert{}
|
|
||||||
}
|
|
||||||
|
|
||||||
if _, ok := config.Alerts["log"]; !ok {
|
|
||||||
config.Alerts["log"] = NewLogAlert()
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// Finish initializing configuration
|
// Finish initializing configuration
|
||||||
if err = config.Init(); err != nil {
|
if err = config.Init(); err != nil {
|
||||||
return
|
return
|
||||||
|
@ -15,7 +15,6 @@ func TestLoadConfig(t *testing.T) {
|
|||||||
}{
|
}{
|
||||||
{"./test/valid-config.yml", false, "Valid config file", false},
|
{"./test/valid-config.yml", false, "Valid config file", false},
|
||||||
{"./test/valid-config-default-values.yml", false, "Valid config file with default values", false},
|
{"./test/valid-config-default-values.yml", false, "Valid config file with default values", false},
|
||||||
{"./test/valid-default-log-alert.yml", false, "Valid config file with default log alert PyCompat", true},
|
|
||||||
{"./test/valid-default-log-alert.yml", true, "Invalid config file no log alert", false},
|
{"./test/valid-default-log-alert.yml", true, "Invalid config file no log alert", false},
|
||||||
{"./test/does-not-exist", true, "Invalid config path", false},
|
{"./test/does-not-exist", true, "Invalid config path", false},
|
||||||
{"./test/invalid-config-type.yml", true, "Invalid config type for key", false},
|
{"./test/invalid-config-type.yml", true, "Invalid config type for key", false},
|
||||||
@ -25,8 +24,6 @@ func TestLoadConfig(t *testing.T) {
|
|||||||
|
|
||||||
for _, c := range cases {
|
for _, c := range cases {
|
||||||
log.Printf("Testing case %s", c.name)
|
log.Printf("Testing case %s", c.name)
|
||||||
// Set PyCompat based on compatibility mode
|
|
||||||
PyCompat = c.pyCompat
|
|
||||||
_, err := LoadConfig(c.configPath)
|
_, err := LoadConfig(c.configPath)
|
||||||
hasErr := (err != nil)
|
hasErr := (err != nil)
|
||||||
|
|
||||||
@ -34,9 +31,6 @@ func TestLoadConfig(t *testing.T) {
|
|||||||
t.Errorf("LoadConfig(%v), expected_error=%v actual=%v", c.name, c.expectErr, err)
|
t.Errorf("LoadConfig(%v), expected_error=%v actual=%v", c.name, c.expectErr, err)
|
||||||
log.Printf("Case failed: %s", c.name)
|
log.Printf("Case failed: %s", c.name)
|
||||||
}
|
}
|
||||||
|
|
||||||
// Set PyCompat to default value
|
|
||||||
PyCompat = false
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
4
main.go
4
main.go
@ -17,9 +17,6 @@ var (
|
|||||||
// Metrics contains all active metrics
|
// Metrics contains all active metrics
|
||||||
Metrics = NewMetrics()
|
Metrics = NewMetrics()
|
||||||
|
|
||||||
// PyCompat enables support for legacy Python templates
|
|
||||||
PyCompat = false
|
|
||||||
|
|
||||||
// version of minitor being run
|
// version of minitor being run
|
||||||
version = "dev"
|
version = "dev"
|
||||||
|
|
||||||
@ -97,7 +94,6 @@ func main() {
|
|||||||
|
|
||||||
flag.BoolVar(&slog.DebugLevel, "debug", false, "Enables debug logs (default: false)")
|
flag.BoolVar(&slog.DebugLevel, "debug", false, "Enables debug logs (default: false)")
|
||||||
flag.BoolVar(&ExportMetrics, "metrics", false, "Enables prometheus metrics exporting (default: false)")
|
flag.BoolVar(&ExportMetrics, "metrics", false, "Enables prometheus metrics exporting (default: false)")
|
||||||
flag.BoolVar(&PyCompat, "py-compat", false, "Enables support for legacy Python Minitor config. Will eventually be removed. (default: false)")
|
|
||||||
flag.IntVar(&MetricsPort, "metrics-port", MetricsPort, "The port that Prometheus metrics should be exported on, if enabled. (default: 8080)")
|
flag.IntVar(&MetricsPort, "metrics-port", MetricsPort, "The port that Prometheus metrics should be exported on, if enabled. (default: 8080)")
|
||||||
flag.Parse()
|
flag.Parse()
|
||||||
|
|
||||||
|
Loading…
Reference in New Issue
Block a user