zappem/zappem-laravel

连接您的Laravel应用与Zappem

v1.0.5 2016-11-24 00:05 UTC

This package is not auto-updated.

Last update: 2024-09-23 14:44:20 UTC


README

连接您的Laravel应用与Zappem

安装

$ composer require zappem/zappem-laravel

然后,将以下行添加到您的 ServiceProviders 数组中的 config/app.php

Zappem\ZappemLaravel\ServiceProvider::class

配置

现在您需要配置Zappem。您可以在您的env文件中定义您的配置。

环境变量包括:

ZAPPEM_URL=https://:3000
ZAPPEM_PROJECT=123456
ZAPPEM_ENABLE=true
  • ZAPPEM_URL - Zappem运行的完整URL(包括端口号)。
  • ZAPPEM_PROJECT - 此应用的工程ID。您可以在Zappem中找到它。
  • ZAPPEM_ENABLE - true/false

或者您也可以在配置文件中定义这些值。

$ php artisan vendor:publish

配置文件将位于 /config/zappem.php

注意:当在Laravel中更改配置变量时,您可能需要重新构建缓存

$ php artisan config:cache

使用方法

您的应用应该在 app/Exceptions/Handler.php 中的 report() 函数向Zappem报告错误。

以下是一个示例

public function report(Exception $e){
    if(Config::get('services.zappem.zappem_enable')) \Zappem::exception($e)->send();
}

传递用户信息

如果您的应用需要用户登录,您可以向Zappem发送当前登录的用户。这将使Zappem在查看异常时显示出来。

public function report(Exception $e){
    if(Config::get('services.zappem.zappem_enable')) \Zappem::exception($e)->user(Auth::user()->id)->send();
}

当前 user() 函数接受字符串或整数。您应该传递一个唯一标识符。这可能是一个ID、电子邮件地址等。

获取错误代码

每次您将异常发送到Zappem时,我们都会向您发送一个短的唯一数字代码。这可能对显示给用户很有用。在Zappem中,您可以通过代码搜索并直接跳转到异常。

错误代码将包含在发送异常给我们的返回值中。以下是一个示例

$Zappem = \Zappem::exception($e)
->user(Auth::user()->id, Auth::user()->name, Auth::user()->email)
->send();

if($Zappem->success){
  return "Sorry, an error occurred. Please contact development quoting this code: ".$Zappem->code;
}