README

将消息发送到 Slack，与您的 Laravel 应用程序。

此包提供

• 后命令

  使用Laravel命令向Slack发送消息。

• 统计命令

  使用此可定制的命令发送有关您的Laravel应用程序的统计信息。

  

• 异常处理器

  在异常发生时输出到Slack的有用信息。

  

• 失败的工作处理器

  当工作失败时收到警报。

  

• 计划命令报告

  关注您计划命令的结果。

  

需求

• Laravel 5.1 或更高版本
• PHP 5.5.9 或更高版本

安装

您可以使用 Composer 包管理器安装此包。您可以在项目根目录中运行以下命令进行安装：

composer require nicolasmahe/laravel-slack-output

您需要在您的Laravel应用程序中包含服务提供者和外观。

将服务提供者添加到 config/app.php 文件中的 providers 数组

'providers' => [
  ...
  NicolasMahe\SlackOutput\ServiceProvider::class,
],

然后添加外观到您的 aliases 数组

'aliases' => [
  ...
  'SlackOutput' => NicolasMahe\SlackOutput\Facade\SlackOutput::class,
],

使用以下命令发布配置文件

php artisan vendor:publish --provider="NicolasMahe\SlackOutput\ServiceProvider"

您需要将webhook URL添加到配置文件中，以便包可以发布到Slack。在您的Slack账户上 创建一个入站webhook。复制webhook URL，打开 config/slack-output.php 并将webhook URL设置为 endpoint。

如果任何一项设置为 null，则包将回退到webhook设置的默认设置。

用法

后命令

命令 slack:post 将消息发布到Slack。它可以接受以下参数

• message: 要发送的消息
• to: 要发布到的频道或人员
• attach: 附件负载

您可以在此处找到有关attach参数的信息： https://api.slack.com/docs/attachments

您可以通过运行以下命令来调用它

php artisan slack:post "Hello, I'm a bot" @nico

您也可以在您的Laravel应用程序中调用它

Artisan::queue('slack:post', [
  'to' => "#api-output",
  'attach' => $someAttachment,
  'message' => "Hello, I'm a bot"
]);

注意 Artisan::queue，该命令将在后台执行，不会阻塞当前请求。

统计命令

命令 slack:stats 将有关应用程序的有用统计信息发送到Slack。

您需要通过在 config/slack-output.php 中设置您偏好的Eloquent类和日期来配置此命令。

您可以为类添加约束以限制计数的数量。

'classes' => [
	  \App\Models\User::class => [
		  'is_active' => true //optional constraint
	  ]
],

日期数组的形式为 '日期名称' => Carbon::instance()。例如

'dates' => [
	'yesterday' => \Carbon\Carbon::yesterday(),
	'last week' => \Carbon\Carbon::today()->subWeek(1)
]

要每天调度此命令，简单地将以下内容添加到 app/Console/Kernel.php

protected function schedule(Schedule $schedule)
{
  $schedule->command('slack:stats')->daily()
}

异常处理器

要向Slack报告有用的异常，打开 app/Exceptions/Handler.php，并修改如下

use NicolasMahe\SlackOutput\Facade\SlackOutput;

...

public function report(Exception $e)
{
  if ($this->shouldReport($e)) {
    SlackOutput::exception($e);
  }

  parent::report($e);
}

这将仅报告不在同一文件中的 $dontReport 数组中的异常。

失败的工作处理器

要向Slack报告失败的工作，打开 app/Providers/AppServiceProvider.php，并修改如下

use NicolasMahe\SlackOutput\Facade\SlackOutput;

...

public function boot()
{
  Queue::failing(function (JobFailed $job) {
    SlackOutput::jobFailed($job);
  });
}

计划命令报告

要向Slack报告计划命令的输出，打开 app/Console/Kernel.php，并修改如下

use NicolasMahe\SlackOutput\Facade\SlackOutput;

...

protected function schedule(Schedule $schedule)
{
  SlackOutput::scheduledCommand(
    $schedule->command('db:backup-auto')->daily()
  );
}

贡献

如果您有问题、发现错误或建议功能，请在GitHub上创建一个问题。也欢迎提交拉取请求！

许可

此包是开源软件，许可证为 MIT 许可