Download the PHP package sheershoff/yii2-sentry-component without Composer
On this page you can find all versions of the php package sheershoff/yii2-sentry-component. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download sheershoff/yii2-sentry-component
More information about sheershoff/yii2-sentry-component
Files in sheershoff/yii2-sentry-component
Package yii2-sentry-component
Short Description A Yii2 component for Sentry allowing data arrays passing through Yii2 logging methods
License MIT
Informations about the package yii2-sentry-component
Usage of this fork is strongly discouraged
This fork is abandoned and left for those who still uses it (if any at all). Stick to https://github.com/E96/yii2-sentry instead.
Yii2 sentry component
Yii2 Sentry component allowing for unified array format passing parameters to Sentry log target and other log targets. The ability to pass arrays as the log message is suitable practice for those who want to use Logstash, ElasticSearch, etc. for getting statistical inferences of these data later on.
Install
In config file:
If application doesn't have raven
component, the component will not try to send messages to sentry. This is useful for development environments, for example.
Usage
Exceptions and PHP errors are caught without effort. Standart Yii::(error|warning|info|trace)
logging works as usual, but you also can use the following format:
Or you can replace this with Log::warning
as in the exception example below, since the exception argument is not required. Notice that eventCategory
is not sent to Sentry and is used only for log messages routing and filtering.
Wherever you need to log a caught exception with stacktrace and additional data, use
There are proxy methods in Log
for the four Yii static methods: error
, warning
, info
, trace
. If $e
is not null the component expects that it is an exception and after calling the
corresponding Yii method also captures the exception for Sentry.
Also, the following use cases are possible:
Or just capture a message with full stacktrace:
Other log targets
To use the power of the component you should keep in mind that other log targets will receive arrays instead of strings in the log message. You can create a proxy class, redefining formatMessage
method of the parent LogTarget, e.g.:
Data precautions
- Avoid passing resources and objects that can not be serialized in the array or rewrite formatMessage to handle that, e.g. trying to serialize PDO instance will raise fatal PHP error. Native Yii log targets will try to serialize that. One can check http://github.com/raven/raven to see how it sanitizes and handles these cases and use it's static methods.
- Also check how raven can filter out private data such as password or sensitive financial requisites.