双倍亚 / Slack异常记录器包
将symfony2异常记录到Slack频道
Requires
- php: >=5.3.2
- symfony/framework-bundle: ~3.0
This package is not auto-updated.
Last update: 2024-09-27 21:58:12 UTC
README
#为Symfony2提供的Slack异常记录器包
此包允许在symfony2应用程序中抛出的异常自动记录到Slack频道。
要使用它,您首先需要在Slack中设置一个入站钩子 - 您可以在https://your_slack_instance.slack.com/services/new/incoming-webhook(将your_slack_instance替换为您特定的Slack实例名称)处完成此操作。一旦完成,您将获得一个webhook URL - 请记下该URL,您需要将其添加到您的config.yml
文件中。
将此包安装到您的symfony应用程序中
$ composer require dopiaza/slack-exception-logger-bundle
然后,将包添加到AppKernel.php
中的registerBundles
new Dopiaza\Slack\ExceptionLoggerBundle\DopiazaSlackExceptionLoggerBundle(),
然后设置您的config.yml
dopiaza_slack_exception_logger:
webhook: https://hooks.slack.com/services/T0000000/B000000000/000000000000000000
botname: symfony-bot
name: My Symfony Application
environments:
test:
enabled: true
color: '#992255'
channel: symfony-exceptions
prod:
channel: symfony-exceptions
exclude_exception:
- Symfony\Component\HttpKernel\Exception\NotFoundHttpException
webhook
是您的Slack实例的入站webhook URL。
botname
是消息将发布的用户名,在您的Slack频道中。它没有默认值。如果没有指定值,Slack将使用入站webhook集成中指定的名称。
name
是您的symfony应用程序的名称。如果您有多个应用程序都发布到同一个频道,这将很有用。
environments
包含所有环境特定的配置设置。通常,您需要在此处包含的常用环境值是dev
、test
和prod
。如果正在使用的环境未在此部分列出,则不会发布任何异常。您可能真的不想在这里列出dev
,因为这个值可能会产生相当多的噪音,但那是您自己的选择。
enabled
是一个可选的布尔值,允许按频道启用或禁用记录。如果没有指定,则默认为true。
color
是一个可选字段,用于确定消息侧边的颜色。有效值是good
(绿色)、warning
(黄色)、danger
(红色)或任何十六进制值(例如'#abcdef'
)。请注意,如果您使用十六进制值,请确保将其放在引号内,否则#
将被解释为注释的开始,侧边栏将显示为不吸引人的灰色。
channel
是要发布异常的频道名称。
exclude_exception
是一个可选数组,其中包含应忽略的Exception
类名称。此用法的一个典型例子是避免在公开可见的生产服务器上显示大量“未找到”异常。