README

英文版本

是什么

TellMe 是一个报警推送的工具，主要功能是消息推送，可以让大家及时收到生产的错误反馈。目前支持微信、瀑布（零信）、Slack、Email、钉钉这几种方式的推送。

安装

composer require barbery/tellme:dev-master

示例

<?php

use Barbery\TellMe\Tellme;

// 首先配置好需要推送的channels
// 这些配置建议放到框架的配置文件里面
$config = [
    'channels' => [
        [
            'template_id'  => 'YOUR TEMPLATE ID',
            'provider'     => 'wechat',
            'to'           => [],
            'easywechat'   => null,
            'access_token' => '',
            'wechat'       => [
                'app_id'  => 'your-app-id',
                'secret'  => 'your-app-secret',
                'token'   => 'your-token',
                'aes_key' => '',
            ],
            'data'         => [
                'first'    => '{message}',
                'keyword1' => '{level}',
                'keyword2' => '{file}:{line}',
                'keyword3' => '{time}',
                'remark'   => '详细信息：{trace}',
            ],
        ],
        [
            'url'      => 'YOUR SLACK URL',
            'provider' => 'slack',
            'data'     => [
                'username' => 'tellme-bot',
                'icon_url' => 'http://ww3.sinaimg.cn/large/7376ce75gw1fbljeafka2j206k09amxh.jpg',
                'text'     => "{message} \n {trace}",
            ],
        ],
        [
            'provider' => 'dingtalk',
            'url'      => 'YOUR DINGTALK URL',
            'data'     => [
                'msgtype' => 'text',
                'text'    => [
                    'content' => "{message} \n {trace}",
                ],
                'at'      => [
                    'atMobiles' => [],
                    'isAtAll'   => false,
                ],
            ],
        ],
    ],
];


// 自动执行方式，通过设置set_exception_handler，set_error_handler方式来自动调用
// 由于部分框架有内部的注册异常处理，所以该方式可能会和框架框架内置的异常处理冲突了
TellMe::registerThrowableHandler($config);

// 手动执行方式，你可以try{}catch(Throwable){}框架的入口代码，捕捉到错误后手动执行发送
// 或者放置到框架错误处理的地方，像laravel的话，放置到App\Exceptions\Handler.php的里面。
(new TellMe($config))->send($e);

配置说明

data变量设置

以下变量在data配置下才有用，需要用大括号进行包裹，例如{code}

微信

Slack

Email