https://github.com/yiisoft/yii-sentry
Sentry adapter for Yii 3
https://github.com/yiisoft/yii-sentry
errors hacktoberfest sentry yii3
Last synced: 10 months ago
JSON representation
Sentry adapter for Yii 3
- Host: GitHub
- URL: https://github.com/yiisoft/yii-sentry
- Owner: yiisoft
- License: bsd-3-clause
- Created: 2020-08-08T08:46:16.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2025-04-05T06:01:49.000Z (10 months ago)
- Last Synced: 2025-04-10T20:39:35.122Z (10 months ago)
- Topics: errors, hacktoberfest, sentry, yii3
- Language: PHP
- Homepage: https://www.yiiframework.com/
- Size: 76.2 KB
- Stars: 18
- Watchers: 19
- Forks: 11
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: .github/CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE.md
- Code of conduct: .github/CODE_OF_CONDUCT.md
- Security: .github/SECURITY.md
Awesome Lists containing this project
README
Yii Sentry
[](https://packagist.org/packages/yiisoft/yii-sentry)
[](https://packagist.org/packages/yiisoft/yii-sentry)
[](https://github.com/yiisoft/yii-sentry/actions?query=workflow%3Abuild)
[](https://codecov.io/gh/yiisoft/yii-sentry)
[](https://dashboard.stryker-mutator.io/reports/github.com/yiisoft/yii-sentry/master)
[](https://github.com/yiisoft/yii-sentry/actions?query=workflow%3A%22static+analysis%22)
The package provides [Sentry](https://sentry.io/) integration for [Yii Framework](https://www.yiiframework.com/).
## Requirements
- PHP 8.0 or higher.
## Installation
The package could be installed with [Composer](https://getcomposer.org).
The package needs PSR-compatible HTTP client and factories so require it additionally to this package:
```shell
composer install httpsoft/http-message
composer install php-http/guzzle7-adapter
composer install yiisoft/yii-sentry
```
The first two can be replaced to other packages of your choice.
For handling console errors `yii-console` and `yii-event` packages are required additionally:
```shell
composer install yiisoft/yii-console
composer install yiisoft/yii-event
```
Add `SentryMiddleware` to main application middleware set and configure DSN in `config/params.php`. Console errors
are captured by default, there is no need to configure anything.
```php
return [
// ...
'middlewares' => [
ErrorCatcher::class,
SentryMiddleware::class, // <-- here
SessionMiddleware::class,
CookieMiddleware::class,
CookieLoginMiddleware::class,
LocaleMiddleware::class,
Router::class,
],
// ...
'yiisoft/yii-sentry' => [
'handleConsoleErrors' => false, // Add to disable console errors.
'options' => [
// Set to `null` to disable error sending (note that in case of web application errors it only prevents
// sending them via HTTP). To disable interactions with Sentry SDK completely, remove middleware and the
// rest of the config.
'dsn' => $_ENV['SENTRY_DSN'] ?? null,
'environment' => $_ENV['YII_ENV'] ?? null, // Add to separate "production" / "staging" environment errors.
],
],
// ...
]
```
Note that fatal errors are handled too.
In `options` you can also pass additional Sentry configuration. See
[official Sentry docs](https://docs.sentry.io/platforms/php/configuration/options/) for keys and values.
## Documentation
- [Internals](docs/internals.md)
If you need help or have a question, the [Yii Forum](https://forum.yiiframework.com/c/yii-3-0/63) is a good place for that.
You may also check out other [Yii Community Resources](https://www.yiiframework.com/community).
## License
The Yii Sentry is free software. It is released under the terms of the BSD License.
Please see [`LICENSE`](./LICENSE.md) for more information.
Maintained by [Yii Software](https://www.yiiframework.com/).
## Support the project
[](https://opencollective.com/yiisoft)
## Follow updates
[](https://www.yiiframework.com/)
[](https://twitter.com/yiiframework)
[](https://t.me/yii3en)
[](https://www.facebook.com/groups/yiitalk)
[](https://yiiframework.com/go/slack)