exolnet/wp-graylog

添加一个mu插件,用于注册Monolog处理程序并将异常发送到Graylog通道。

安装次数: 3,226

依赖项: 0

建议者: 0

安全性: 0

星标: 3

关注者: 4

分支: 0

开放问题: 0

类型:wordpress-muplugin

v2.0.1 2022-10-20 15:33 UTC

This package is auto-updated.

Last update: 2024-08-30 01:27:06 UTC


README

Software License Build Status Latest Stable Version Total Downloads

添加一个mu插件,用于注册Monolog处理程序并将异常发送到Graylog通道。

需求

  • Bedrock
  • Composer
  • PHP 7.3 或更高版本
  • Wordpress

安装

使用Composer安装此包

composer require exolnet/wp-graylog

在您的 config/application.php 文件中定义以下PHP常量

/**
 * wp-graylog
 *
 * Here you may configure the Graylog channel for your application. Behind the
 * scene, it uses the Monolog PHP logging library.
 */
Config::define('GRAYLOG_TRANSPORT', env('GRAYLOG_TRANSPORT'));
Config::define('GRAYLOG_HOST', env('GRAYLOG_HOST'));
Config::define('GRAYLOG_PORT', env('GRAYLOG_PORT'));
Config::define('GRAYLOG_LEVEL', env('GRAYLOG_LEVEL'));

然后,更新您的 .env 文件以添加 GRAYLOG_HOST 环境变量

GRAYLOG_HOST=localhost

用法

安装后,所有级别高于或等于 GRAYLOG_LEVEL 的代码错误将被发送到指定的Graylog实例。您将能够将所有日志集中在一个地方。

支持的传输方式

以下传输方式得到支持:UDPTCPSSLHTTPHTTPS。根据您的Graylog设置,使用 GRAYLOG_TRANSPORT 配置选择相应的传输方式。默认情况下,使用 UDP 传输方式。

HTTPHTTPS 传输方式的默认路径是 /gelf。此值可以通过 GRAYLOG_PATH 配置进行设置。

Config::define('GRAYLOG_PATH', env('GRAYLOG_PATH', '/gelf'));

应用程序名称

默认情况下,使用博客名称作为应用程序名称,但您可以使用变量 GRAYLOG_APP 覆盖它

Config::define('GRAYLOG_APP', 'custom-app-name');

禁用默认错误处理器

默认情况下,如果配置了 GRAYLOG_HOST,则将配置PHP错误处理器以将所有错误发送到Graylog。可以通过配置以下环境变量禁用此行为

Config::define('GRAYLOG_INITIALIZE_ERROR_HANDLER', false);

捕获错误

您可以捕获捕获的异常或捕获最后错误

try {
    $this->functionFailsForSure();
} catch (\Throwable $exception) {
    \Exolnet\Wordpress\Graylog\WpGraylog::captureException($exception);
}

// OR

\Exolnet\Wordpress\Graylog\WpGraylog::captureLastError();

测试

要运行PHPUnit测试,请使用

composer test

贡献

有关详细信息,请参阅 CONTRIBUTING行为准则

安全性

如果您发现任何安全相关的问题,请通过电子邮件 security@exolnet.com 联系我们,而不是使用问题跟踪器。

致谢

许可证

此代码在 MIT 许可证 下发布。有关更多信息,请参阅 许可证文件