Legacy SDK
Deprecation Warning
A new PHP SDK has superseded this deprecated version. Sentry preserves this documentation for customers using the old client. If you are using PHP 7.1 or later, we recommend using the updated PHP SDK for your projects.
This PHP SDK for Sentry supports PHP 5.3 and higher. It’s available as a BSD licensed Open Source library.
Getting started with Sentry is a three step process:
There are various ways to install the PHP integration for Sentry. The recommended way is to use Composer:
composer require sentry/sentry "^1.0"
Alternatively you can manually install it:
Download and extract the latest sentry-php archive to your PHP project.
Require the autoloader in your application:
Copiedrequire_once '/path/to/Raven/library/Raven/Autoloader.php'; Raven_Autoloader::register();
The most important part is the creation of the raven client. Create it once and reference it from anywhere you want to interface with Sentry:
$client = new Raven_Client('https://examplePublicKey@o0.ingest.sentry.io/0');
Once you have the client you can either use it manually or enable the automatic error and exception capturing which is recommended:
$error_handler = new Raven_ErrorHandler($client);
$error_handler->registerExceptionHandler();
$error_handler->registerErrorHandler();
$error_handler->registerShutdownFunction();
Much of the usefulness of Sentry comes from additional context data with the events. The PHP client makes this very convenient by providing methods to set thread local context data that is then submitted automatically with all events. For instance you can use the user_context method to add information about the current user:
$client->user_context(array(
'email' => $USER->getEmail()
));
For more information see Providing Request Context.
Want more? Have a look at the full documentation for more information.
Resources:
Our documentation is open source and available on GitHub. Your contributions are welcome, whether fixing a typo (drat!) or suggesting an update ("yeah, this would be better").