Small command-line and HTTP utilities for operating MariaDB servers and clusters.

The repository is a Go module and contains several independent binaries. Build only the tools you need, or install them all at once.

mariadb-repmgr has moved to signal18/replication-manager.

Download prebuilt binaries from the GitHub releases page, then place the binary you need somewhere in your PATH, for example /usr/local/bin.

Go 1.21 or newer is required.

git clone https://github.com/tanji/mariadb-tools.git
cd mariadb-tools

go install ./mariadb-report ./mariadb-status ./mariadb-top ./mariadb-msm ./galeracheck ./servercheck

The binaries are installed into GOBIN when set, otherwise into $(go env GOPATH)/bin.

To build a single tool locally instead:

go build ./mariadb-report
go build ./galeracheck

mariadb-report, mariadb-status, and mariadb-top use command-line credentials:

mariadb-report -user monitor -password secret
mariadb-report -host 127.0.0.1 -port 3306 -user monitor -password secret

If -host is not supplied, these tools connect through a Unix socket. The default socket is /var/run/mysqld/mysqld.sock.

mariadb-msm also uses command-line credentials, but its -user option expects user:password.

galeracheck and servercheck read credentials from a MySQL option file. They look for a [mysql] section first, then [client]:

[mysql]
user=monitor
password=secret
socket=/run/mysqld/mysqld.sock

For TCP monitoring, use host and port instead of socket:

[mysql]
user=monitor
password=secret
host=127.0.0.1
port=3306

Prints a one-shot report with general server details, InnoDB settings, MyISAM cache usage, open table/file counters, and replication state.

mariadb-report -user monitor -password secret
mariadb-report -host db01.example.com -port 3306 -user monitor -password secret

Options: -user, -password, -host, -port, -socket, -version.

Prints changing server activity counters continuously.

mariadb-status -user monitor -password secret -interval 5 -average

Options: -user, -password, -host, -port, -socket, -interval, -average, -collect, -influxdb, -version.

-collect is experimental and writes to an InfluxDB instance at localhost:8086.

Shows a terminal process-list view that refreshes every few seconds.

mariadb-top -user monitor -password secret

Options: -user, -password, -host, -port, -socket, -version.

Press Ctrl-Q to quit and Ctrl-S to force a terminal sync.

Checks every configured multi-source replication channel. It exits after one check by default, or runs continuously when -interval is set.

mariadb-msm -user monitor:secret -socket /var/run/mysqld/mysqld.sock -verbose
mariadb-msm -user monitor:secret -host db01.example.com:3306 -email dba@example.com -interval 5

Options: -user, -host, -socket, -email, -from, -interval, -verbose, -version.

-interval is in minutes. Email alerts are sent through SMTP on localhost:25.

More details: mariadb-msm/README.md.

Runs an HTTP endpoint for load balancer health checks. A synced Galera node returns HTTP 200; unavailable, disconnected, or manually disabled nodes return HTTP 503.

galeracheck -config /etc/galeracheck/my.cnf -port 8000
galeracheck -config /etc/galeracheck/my.cnf -port 8000 -available-when-donor
galeracheck -config /etc/galeracheck/my.cnf -sentinel-file /run/galeracheck.disabled

Options: -config, -port, -mysql-socket, -mysql-host, -mysql-port, -available-when-donor, -disable-when-readonly, -sentinel-file, -version.

More details: galeracheck/README.md.

Runs an HTTP endpoint for replicated server health checks. It returns HTTP 200 when replication is configured and Seconds_Behind_Master is within -maxdelay; otherwise it returns HTTP 503.

servercheck -config /etc/servercheck/my.cnf -port 8000 -maxdelay 5

Options: -config, -port, -mysql-socket, -mysql-host, -mysql-port, -maxdelay.

Use a dedicated monitoring account. The exact grants depend on the tool and MariaDB version, but these utilities commonly need to read global status, variables, process list, and replication status.

CREATE USER 'monitor'@'localhost' IDENTIFIED BY 'secret';
GRANT PROCESS, REPLICATION CLIENT ON *.* TO 'monitor'@'localhost';
FLUSH PRIVILEGES;

For remote monitoring, create the user for the appropriate client host instead of localhost.

Run the full package build:

go build ./...

Format changed Go files before committing:

gofmt -w <files>

This project is licensed under the GNU General Public License version 2. See LICENSE.