Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/haydenjames/mysqlmonitor-script
MySQL Monitor for the Terminal: A quick tool to view MySQL runtime and performance metrics.
https://github.com/haydenjames/mysqlmonitor-script
linux mariadb mysql percona
Last synced: about 14 hours ago
JSON representation
MySQL Monitor for the Terminal: A quick tool to view MySQL runtime and performance metrics.
- Host: GitHub
- URL: https://github.com/haydenjames/mysqlmonitor-script
- Owner: haydenjames
- License: gpl-3.0
- Created: 2025-01-21T18:12:23.000Z (10 days ago)
- Default Branch: main
- Last Pushed: 2025-01-28T20:47:24.000Z (2 days ago)
- Last Synced: 2025-01-28T21:33:52.584Z (2 days ago)
- Topics: linux, mariadb, mysql, percona
- Language: Shell
- Homepage: https://linuxblog.io/mysql-monitor-script/
- Size: 208 KB
- Stars: 9
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Security: SECURITY.md
Awesome Lists containing this project
README
## MySQL Monitor Script
This is a lightweight bash script designed to provide sysadmins and DBAs with a quick overview of MySQL metrics. It displays critical metrics like InnoDB buffer usage, query performance, and system memory, along with brief explanations of each variable.
## How to Install and Use
Cut and paste each step.
### Step 1: Download the script
```bash
curl -O https://raw.githubusercontent.com/haydenjames/mysqlmonitor-script/main/mysqlmonitor.sh
```
### Step 2: Make the script executable
```bash
chmod +x mysqlmonitor.sh
```
### Step 3: Run the script
```bash
./mysqlmonitor.sh
```
Done!
---------------------------------------------------
or...
### Single command install and run
Simply cut and paste. This command will download and run mysqlmonitor.sh immediately.
```bash
curl -O https://raw.githubusercontent.com/haydenjames/mysqlmonitor-script/main/mysqlmonitor.sh && \
chmod +x mysqlmonitor.sh && \
./mysqlmonitor.sh
```
## Complementary Guide
Linuxblog.io: [MySQL Monitor: A Simple MySQL Monitoring Script](https://linuxblog.io/mysql-monitor-script/) - This blog post provides detailed guidance on the variables used in the script, along with links to common MySQL tuning pitfalls and tips to help you optimize your database performance.
## Known bugs
### Fix output when screensize is too small.
When the terminal window's height is smaller than the number of lines the script attempts to display, the terminal starts scrolling. This results in repetitive or overlapping content, making the output unreadable.
In the meantime, I've added a check for minimum terminal size. The minimum is 95×55.
## TO DO
### Add a Help screen
Add a --help flag for users who want to see usage information.
## Common Troubleshooting
Here are some common issues and how to resolve them:
### 1. Missing MySQL Credentials
If the script fails to connect to your MySQL server due to missing credentials, you may need to create a `~/.my.cnf` file for automatic authentication.
#### Steps to Create `.my.cnf`:
1. Create the file:
```bash
nano ~/.my.cnf
```
2. Add the following structure to the file:
```makefile
[client]
user=your_mysql_username
password=your_mysql_password
```
3. Secure the file permissions:
```bash
chmod 600 ~/.my.cnf
```
4. Rerun the script.
---
### 2. Running the Script with `sudo`
If you encounter permission issues as a non-root user, try running the script with `sudo`:
```bash
sudo ./mysqlmonitor.sh
```
---
### 3. Verifying MySQL Status
If the script fails to connect even with credentials:
- Ensure the MySQL server is running:
```bash
sudo systemctl status mysql
```
or
```bash
sudo systemctl status mariadb
```
- Verify that the credentials in `~/.my.cnf` are correct.
---------------------------------------------------
Thank you for using MySQL Monitor, we hope it helps simplify your database monitoring and tuning tasks!