README

授权认证： admin / 123456
模块调试系统登录账号： stats / 123456

一、简介

这是一个利用laravel与swoole实现的模块调用监控系统，能够实时监控各个模块和接口的请求情况，包括各接口的请求次数、成功次数、请求耗时、成功率等，从而可以监控系统各模块和接口是否异常，并且可以直观地看出其调用情况。除此之外，还可设置告警功能，包括微信、短信和邮件告警，实时掌控系统接口的调用情况。

二、演示截图

三、安装

1、如果尚未安装swoole扩展，则可以按照以下方式安装：

wget https://github.com/swoole/swoole-src/archive/v4.4.6.tar.gz
tar zxvf v4.4.6.tar.gz
cd swoole-src-4.4.6/
/usr/bin/phpize
./configure --with-php-config=/www/server/php/72/bin/php-config //此处需改为自己的php-config路径

2、在laravel项目根目录下执行：

composer require oyhdd/laravel-stats

此模块调试系统的后台界面基于laravel-admin扩展实现，可方便地进行二次开发。如果尚未安装laravel-admin，则需要再执行以下命令，如果已安装则可忽略。

php artisan vendor:publish --provider="Encore\Admin\AdminServiceProvider"
php artisan admin:install

3、发布资源文件、配置文件及初始化配置

php artisan vendor:publish --provider="Oyhdd\StatsCenter\StatsCenterServiceProvider"

注意：如果文件已存在，可以通过以下命令强制覆盖

php artisan vendor:publish --provider="Oyhdd\StatsCenter\StatsCenterServiceProvider" --force

然后运行以下命令完成安装：

php artisan stats:install

文件发布成功后，会生成配置文件config/statscenter.php

4、配置脚本

数据上报服务：后台运行

php artisan stats:server

数据统计服务：每5分钟运行一次

php artisan stats:sum

数据定时清理服务：每天运行一次，清理90天以前的数据，可在config\statscenter.php中修改配置

php artisan stats:clear

5、访问

在浏览器中打开{host}/admin 后即可访问

四、用法

1、原理

    当有接口请求时，调用 StatsCenter::tick() 统计初始时间，当请求结束时调用 StatsCenter::report() 通过 udp 方式上报数据，其中模块 id 需要向模调系统申请，接口 id 则是先从本地缓存文件获取，若不存在则向模调系统发送 tcp 请求获取，再存入本地缓存文件，若获取失败，则默认为0。

2、调用方式

调用示例可参看：tests\test.php

调用方式可参看已封装好的类：src\StatsCenter.php

StatsCenter::tick() 统计耗时

StatsCenter::tick($interface, $moduleId);

StatsCenter::report() 上报数据

StatsCenter::report($interface, $moduleId, $success, $retCode, $serverIp);

备注：如果自行统计了请求耗时 $costTime，则可以只调用

StatsCenter::report($interface, $moduleId, $success, $retCode, $serverIp, $costTime)

3、配置

可以在config/statscenter.php配置文件中设置相关参数，包括swoole配置、模块调试相关配置和告警配置

联系我们

qq : 1040089624

oyhdd / laravel-stats

维护者

详细信息