ggiovanini/slagger

简化PHP系统日志生成并发送至Slack的工具

v1.0.0 2023-12-19 20:25 UTC

This package is auto-updated.

Last update: 2024-09-19 22:21:22 UTC


README

Slagger 是一个服务抽象,旨在简化PHP系统中任何系统的日志生成并将它们发送到Slack。使用Slagger,您可以创建一个安全且高效的通道来实时收集错误和事件信息。

安装

首先,从GitHub克隆Slagger仓库

git clone git@github.com:ggiovanini/slagger.git

然后,使用以下信息填充您的 .env 文件,替换相应的值

SLACK_CONNECTION="https://hooks.slack.com/services/T00000000/XXXXXXXXX/000000000000000000000000"
SLACK_CHANNEL=XXXXXXXXXXX

确保这些信息保密,不要共享敏感密钥。

注意: 如果要部署的系统不会自动加载环境变量(env),则需要手动初始化它们。请使用以下代码

$dotenv = Dotenv\Dotenv::createImmutable(__DIR__);
$dotenv->load();

配置Slack Webhook

  1. 访问Slack:在 https://slack.com/ 登录您的Slack账户。

  2. 选择频道:选择您希望接收通知的频道。

  3. 访问频道设置:在左侧边栏点击频道名称,然后点击齿轮图标(“频道设置”)。

  4. 频道设置:在弹出菜单中选择“频道设置”。

  5. 集成:在设置菜单中点击“集成”。

  6. 配置入站Webhook:如果您尚未配置入站Webhook,请点击“入站Webhook”并启用选项。

  7. 为频道添加Webhook:点击“为频道添加Webhook”并按照说明添加新的webhook。

  8. 配置Webhook:添加webhook后,您将看到一个生成的webhook URL。根据需要配置其他选项。

  9. 保存设置:向下滚动,找到“保存设置”按钮并点击。

  10. 测试Webhook:下面,您将看到一个“测试您的集成”字段。点击发送测试消息以确保webhook正常工作。

  11. 完成:一旦测试成功,webhook已配置并准备好接收通知。

基本使用

要向默认频道发送消息,请使用 sendMessage 方法。

Slagger::sendMessage('Hello Slack');

如果您想向特定频道发送消息,可以使用 withChannel 方法。

Slagger::withChannel('XXXXXXXXX')
    ->createMessage('Hello with Channel string!')
    ->send();

您还可以创建一个单独的 Channel 对象以用于多个消息。

$outroChannel = new Channel('XXXXXXXXX');
Slagger::withChannel($outroChannel)
    ->createMessage('Hello with Channel object!')
    ->send();

以下示例演示了如何使用Slagger创建、配置并发送特定频道的消息。

贡献

欢迎为Slagger的开发做出贡献!如果您发现问题或有建议,请通过 GitHub 提交问题。

感谢您使用Slagger!