README

本包为与PHP Rollbar SDK一起使用的额外策略提供。基本的Rollbar SDK包含一些默认的截断策略，但它们并不总是能满足所有需求。配置允许指定用于转换、截断等的自定义策略，本包旨在提供一些这些自定义策略。

安装

通过Composer

$ composer require shiftonelabs/php-rollbar-extensions

配置

Rollbar配置依赖于所使用的框架/应用程序。

安装PHP的Rollbar的Rollbar文档： https://docs.rollbar.com/docs/php

Rollbar配置选项： https://docs.rollbar.com/docs/php-configuration-reference

用法

本包提供了一组类，可以将它们提供给Rollbar配置。在大多数情况下，使用此队列驱动程序与内置队列驱动程序的用法相同。然而，在与亚马逊的SQS FIFO队列一起工作时，还有一些额外的事项需要考虑。

自定义数据方法

允许在错误报告期间运行时创建动态自定义数据。这个可调用的参数有两个 $toLog（记录的内容上下文）和 $context（配置中提供的附加上下文数据）。您可以通过向 $extra 或 $context 参数 Rollbar::log 或 RollbarLogger::log 中添加 custom_data_method_context 键来提供 $context。

-- Rollbar配置参考

要指定要使用的自定义数据方法，请将Rollbar配置的 custom_data_method 键设置为可调用的自定义数据方法类的新实例。这些类应实现 \ShiftOneLabs\PhpRollbarExtensions\CustomDataInterface 接口。

目前还没有可用的自定义数据方法。

自定义截断

自定义截断策略类的完全限定名称。它必须继承自 \Rollbar\Truncation\AbstractStrategy。此自定义策略将在内置策略之前应用。

-- Rollbar配置参考

要指定要使用的自定义截断，请将Rollbar配置的 custom_truncation 键设置为要使用的类的完全限定名称。

目前还没有可用的自定义截断方法。

转换器

从Rollbar

在将有效载荷准备发送到Rollbar API之前，用于转换该类的类。它必须实现 \Rollbar\TransformerInterface。

-- Rollbar配置参考

要指定要使用的转换器，请将Rollbar配置的 transformer 键设置为要使用的类的完全限定名称。

可用的转换器

添加ExceptionPropertiesTransformer

当异常记录到Rollbar时，只有基本的异常信息被发送到Rollbar（异常名称、消息、代码、行号、文件、先前异常和堆栈跟踪）。但是，如果您创建了一个带有附加属性的自定义异常，则默认情况下不会将这些属性的值发送到Rollbar。有时这些信息对于调试问题非常有价值。

AddExceptionPropertiesTransformer 转换器会将异常上存储的所有数据添加到 Rollbar 有效载荷的 "custom" 元素下，以新的 "properties" 键。这包括所有定义的公共、受保护以及私有属性，还包括在运行时动态分配的任何属性。此转换器还会遍历异常链，因此还会报告设置中 "previous" 异常的所有属性。这些自定义数据将在 Rollbar 的每次发生中显示。

示例配置：'transformer' => \ShiftOneLabs\PhpRollbarExtensions\Transformers\AddExceptionPropertiesTransformer::class

贡献

欢迎贡献。请参阅 贡献指南 了解详情。

安全

如果您发现任何与安全相关的问题，请通过电子邮件 patrick@shiftonelabs.com 联系，而不是使用问题跟踪器。

鸣谢

• Patrick Carlo-Hickman
• 所有贡献者

许可

MIT 许可证 (MIT)。有关更多信息，请参阅 许可文件。