Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/getsentry/sentry-php
The official PHP SDK for Sentry (sentry.io)
https://github.com/getsentry/sentry-php
crash-reporting crash-reports error-handler error-monitoring hacktoberfest php sentry sentry-client tag-production
Last synced: 15 days ago
JSON representation
The official PHP SDK for Sentry (sentry.io)
- Host: GitHub
- URL: https://github.com/getsentry/sentry-php
- Owner: getsentry
- License: mit
- Created: 2012-01-23T07:34:48.000Z (almost 13 years ago)
- Default Branch: master
- Last Pushed: 2024-05-16T10:57:45.000Z (6 months ago)
- Last Synced: 2024-05-16T11:53:43.879Z (6 months ago)
- Topics: crash-reporting, crash-reports, error-handler, error-monitoring, hacktoberfest, php, sentry, sentry-client, tag-production
- Language: PHP
- Homepage: https://sentry.io
- Size: 3.68 MB
- Stars: 1,797
- Watchers: 89
- Forks: 449
- Open Issues: 20
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Authors: AUTHORS
Awesome Lists containing this project
README
_Bad software is everywhere, and we're tired of it. Sentry is on a mission to help developers write better software faster, so we can get back to enjoying technology. If you want to join us [**Check out our open positions**](https://sentry.io/careers/)_
# Official Sentry SDK for PHP
[](https://github.com/getsentry/sentry-php/actions?query=workflow%3ACI+branch%3Amaster)
[](https://codecov.io/gh/getsentry/sentry-php/branch/master)
[](https://packagist.org/packages/sentry/sentry)
[](https://packagist.org/packages/sentry/sentry)
[](https://packagist.org/packages/sentry/sentry)
[](https://packagist.org/packages/sentry/sentry)
[](https://discord.gg/cWnMQeA)
The Sentry PHP error reporter tracks errors and exceptions that happen during the
execution of your application and provides instant notification with detailed
information needed to prioritize, identify, reproduce and fix each issue.
## Getting started
### Install
Install the SDK using [Composer](https://getcomposer.org/).
```bash
composer require sentry/sentry
```
### Configuration
Initialize the SDK as early as possible in your application.
```php
\Sentry\init(['dsn' => '___PUBLIC_DSN___' ]);
```
### Usage
```php
try {
thisFunctionThrows(); // -> throw new \Exception('foo bar');
} catch (\Exception $exception) {
\Sentry\captureException($exception);
}
```
## Official integrations
The following integrations are fully supported and maintained by the Sentry team.
- [Symfony](https://github.com/getsentry/sentry-symfony)
- [Laravel](https://github.com/getsentry/sentry-laravel)
## 3rd party integrations using SDK 4.x
The following integrations are available and maintained by members of the Sentry community.
- [Drupal](https://www.drupal.org/project/raven)
- [WordPress](https://wordpress.org/plugins/wp-sentry-integration/)
- ... feel free to be famous, create a port to your favourite platform!
## 3rd party integrations using the old SDK 3.x
- [Neos Flow](https://github.com/flownative/flow-sentry)
- [ZendFramework](https://github.com/facile-it/sentry-module)
- [Yii2](https://github.com/notamedia/yii2-sentry)
- [Silverstripe](https://github.com/phptek/silverstripe-sentry)
- [CakePHP 3.0 - 4.3](https://github.com/Connehito/cake-sentry)
- [CakePHP 4.4+](https://github.com/lordsimal/cakephp-sentry)
- [October CMS](https://github.com/OFFLINE-GmbH/oc-sentry-plugin)
## 3rd party integrations using the old SDK 2.x
- [Neos Flow](https://github.com/networkteam/Networkteam.SentryClient)
- [OXID eShop](https://github.com/OXIDprojects/sentry)
- [TYPO3](https://github.com/networkteam/sentry_client)
- [CakePHP](https://github.com/Connehito/cake-sentry/tree/3.x)
## 3rd party integrations using the old SDK 1.x
- [Neos CMS](https://github.com/networkteam/Netwokteam.Neos.SentryClient)
- [OpenCart](https://github.com/BurdaPraha/oc_sentry)
- [TYPO3](https://github.com/networkteam/sentry_client/tree/2.1.1)
## Community
- [Documentation](https://docs.sentry.io/error-reporting/quickstart/?platform=php)
- [Bug Tracker](http://github.com/getsentry/sentry-php/issues)
- [Code](http://github.com/getsentry/sentry-php)
## Contributing to the SDK
Please make sure to read the [CONTRIBUTING.md](CONTRIBUTING.md) before making a pull request.
Thanks to everyone who has contributed to this project so far.
## Getting help/support
If you need help setting up or configuring the PHP SDK (or anything else in the Sentry universe) please head over to the [Sentry Community on Discord](https://discord.com/invite/sentry). There is a ton of great people in our Discord community ready to help you!
## Resources
- [](https://docs.sentry.io/quickstart/)
- [](https://discord.gg/Ww9hbqr)
- [](http://stackoverflow.com/questions/tagged/sentry)
- [](https://twitter.com/intent/follow?screen_name=getsentry)
## License
Licensed under the MIT license, see [`LICENSE`](LICENSE)