Ian Fijolek e0af17a599 Refactor test package and some field types

Fairly big test refactor and changing some of the fields from pointers

2024-11-15 11:37:03 -08:00

9.0 KiB

Raw Blame History

minitor-go

A minimal monitoring system

What does it do?

Minitor accepts a YAML configuration file with a set of commands to run and a set of alerts to execute when those commands fail. It is designed to be as simple as possible and relies on other command line tools to do checks and issue alerts.

But why?

I'm running a few small services and found Sensu, Consul, Nagios, etc. to all be far too complicated for my usecase.

So how do I use it?

Running

Install and execute with:

go get github.com/iamthefij/minitor-go
minitor

If locally developing you can use:

make run

It will read the contents of config.yml and begin its loop. You could also run it directly and provide a new config file via the -config argument.

Docker

You can pull this repository directly from Docker:

docker pull iamthefij/minitor-go:latest

The Docker image uses a default config.yml that is copied from sample-config.yml. This won't really do anything for you, so when you run the Docker image, you should supply your own config.yml file:

docker run -v $PWD/config.yml:/app/config.yml iamthefij/minitor-go:latest

Images are provided for amd64, arm, and arm64 architechtures.

Timezone configuration for the container is set by passing the TZ env variable. Eg. TZ=America/Los_Angeles.

Configuring

In this repo, you can explore the sample-config.yml file for an example, but the general structure is as follows. It should be noted that environment variable interpolation happens on load of the YAML file.

The global configurations are:

key	value
`check_interval`	Maximum frequency to run checks for each monitor as duration, eg. 1m2s.
`default_alert_after`	A default value used as an `alert_after` value for a monitor if not specified or 0.
`default_alert_down`	Default down alerts to used by a monitor in case none are provided.
`default_alert_up`	Default up alerts to used by a monitor in case none are provided.
`monitors`	List of all monitors. Detailed description below
`alerts`	List of all alerts. Detailed description below

Monitors

All monitors should be listed under monitors.

Each monitor allows the following configuration:

key	value
`name`	Name of the monitor running. This will show up in messages and logs.
`command`	Specifies the command that should be executed, either in exec or shell form. This command's exit value will determine whether the check is successful
`alert_down`	A list of Alerts to be triggered when the monitor is in a "down" state
`alert_up`	A list of Alerts to be triggered when the monitor moves to an "up" state
`check_interval`	The interval at which this monitor should be checked. This must be greater than the global `check_interval` value
`alert_after`	Allows specifying the number of failed checks before an alert should be triggered. A value of 1 will start sending alerts after the first failure.
`alert_every`	Allows specifying how often an alert should be retriggered. There are a few magic numbers here. Defaults to `-1` for an exponential backoff. Setting to `0` disables re-alerting. Positive values will allow retriggering after the specified number of checks

Alerts

Alerts exist as objects keyed under alerts. Their key should be the name of the Alert. This is used in your monitor setup in alert_down and alert_up.

Eachy alert allows the following configuration:

key	value
`command`	Specifies the command that should be executed, either in exec or shell form. This is the command that will be run when the alert is executed. This can be templated with environment variables or the variables shown in the table below

Also, when alerts are executed, they will be passed through Go's format function with arguments for some attributes of the Monitor. The following monitor specific variables can be referenced using Go formatting syntax:

token	value
`{{.AlertCount}}`	Number of times this monitor has alerted
`{{.FailureCount}}`	The total number of sequential failed checks for this monitor
`{{.LastCheckOutput}}`	The last returned value from the check command to either stderr or stdout
`{{.LastSuccess}}`	The datetime of the last successful check as a go Time struct
`{{.MonitorName}}`	The name of the monitor that failed and triggered the alert
`{{.IsUp}}`	Indicates if the monitor that is alerting is up or not. Can be used in a conditional message template

To provide flexible formatting, the following non-standard functions are available in templates:

func	description
`ANSIC <Time>`	Formats provided time in ANSIC format
`UnixDate <Time>`	Formats provided time in UnixDate format
`RubyDate <Time>`	Formats provided time in RubyDate format
`RFC822Z <Time>`	Formats provided time in RFC822Z format
`RFC850 <Time>`	Formats provided time in RFC850 format
`RFC1123 <Time>`	Formats provided time in RFC1123 format
`RFC1123Z <Time>`	Formats provided time in RFC1123Z format
`RFC3339 <Time>`	Formats provided time in RFC3339 format
`RFC3339Nano <Time>`	Formats provided time in RFC3339Nano format
`FormatTime <Time> <string template>`	Formats provided time according to provided template
`InTZ <Time> <string timezone name>`	Converts provided time to parsed timezone from the provided name

For more information, check out the Go documentation for the time module.

Running alerts on startup

It's not the best feeling to find out your alerts are broken when you're expecting to be alerted about another failure. To avoid this and provide early insight into broken alerts, it is possible to specify a list of alerts to run when Minitor starts up. This can be done using the command line flag -startup-alerts. This flag accepts a comma separated list of strings and will run a test of each of those alerts. Minitor will then respond as it typically does for any failed alert. This can be used to allow you time to correct when initially launching, and to allow schedulers to more easily detect a failed deployment of Minitor.

Eg.

minitor -startup-alerts=log_down,log_up -config ./config.yml

Metrics

Minitor supports exporting metrics for Prometheus. Prometheus is an open source tool for reading and querying metrics from different sources. Combined with another tool, Grafana, it allows building of charts and dashboards. You could also opt to just use Minitor to log check results, and instead do your alerting with Grafana.

It is also possible to use the metrics endpoint for monitoring Minitor itself! This allows setting up multiple instances of Minitor on different servers and have them monitor each-other so that you can detect a minitor outage.

To run minitor with metrics, use the -metrics flag. The metrics will be served on port 8080 by default, though it can be overriden using -metrics-port. They will be accessible on the path /metrics. Eg. localhost:8080/metrics.

minitor -metrics
# or
minitor -metrics -metrics-port 3000

Contributing

Whether you're looking to submit a patch or tell me I broke something, you can contribute through the Github mirror and I can merge PRs back to the source repository.

Primary Repo: https://git.iamthefij.com/iamthefij/minitor.git

Github Mirror: https://github.com/IamTheFij/minitor.git

Original Minitor

This is a reimplementation of 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.

Initial target is meant to be roughly compatible requiring only minor changes to configuration. Future iterations may diverge to take advantage of Go specific features.

Differences from Python 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.

minitor-py:

alerts:
  log:
    command: 'echo {monitor_name}'

minitor-go:

alerts:
  log:
    command: 'echo {{.MonitorName}}'

Interval durations have changed from being an integer number of seconds to a duration string supported by Go, for example: