# HeartbeatOne

**Repository Path**: JohnBeanLee/HeartbeatOne

## Basic Information

- **Project Name**: HeartbeatOne
- **Description**: 一个由PHP实现的MySql主服务器复制（Master/Slave）延迟时间检查器，让你更好的关注读写滞后情况，原理和pt-heartbeat类似。
- **Primary Language**: PHP
- **License**: MIT
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 9
- **Forks**: 0
- **Created**: 2021-03-26
- **Last Updated**: 2025-08-19

## Categories & Tags

**Categories**: database-dev

**Tags**: None

## README

# HeartbeatOne
A MySql master-salve replication lag time checker implementation by PHP more like pt-heartbeat.

## ScreenShot
(command line sample)  
![image](https://user-images.githubusercontent.com/11038908/112451930-0050c600-8d91-11eb-8e43-8e13fb217935.png)

(log file sample)  
![image](https://user-images.githubusercontent.com/11038908/112454479-b0bfc980-8d93-11eb-88e6-0500a100dd1f.png)

## Istall&Usage
### Install
Download this project zip file and deploy on your any one php machine which can access MySql server.
### Setting
Change the `setting.php` according to your actual situation.
```php
<?php

/**
 * Default setting sample
 * 
 */

return [
    'mysqlMasterHost' => '', // Write server host

    'mysqlMasterUser' => '',

    'mysqlMasterPwd' => '',

    'mysqlSlaveHosts' => [], // Slaves host of the master

    'mysqlSlaveUser' => '', // Read server username

    'mysqlSlavePwd' => '',

    'interval' => 1, // Frequency for update monitor time in seconds

    'averages' => [1, 5, 30], // Latest period slave lagging average time in seconds, can be more than three and even more, su as [1, 5, 30, 60 ...]

    'logFilePath' => '/val/logs/',

    'logFileName' => 'HeartbeatOne-Monitor',

    'mysqlDriver' => 'mysqli', // Only support `mysqlli` or `PDO` driver
];

```
### Create Monitor Table
Import `heartbeat.sql` to your MySQl master server which you want tracing.

### Running
Just run following command in cli, you can see dealy time report and wirte to log in the meanwhile if everything is ok.
```shell
php heartbeat.php
```
For the production suggest run in background then only wirte delay data to log file.
```shell
nohup php heartbeat.php > /dev/null &
```
## Details
- Notice! The monitor log content will be clear every 24hours