README

Sentry for PHP

The Sentry PHP error reporter tracks errors and exceptions that happen during the execution of your application and provides instant notification with detailed informations needed to prioritize, identify, reproduce and fix each issue. Learn more about automatic PHP error reporting with Sentry.

Features

Automatically report (un)handled exceptions and errors
Send customized diagnostic data
Process and sanitize data before sending it over the network

Usage

// Instantiate a new client with a compatible DSN and install built-in
// handlers
$client = (new Raven_Client('http://public@example.com/1'))->install();

// Capture an exception
$event_id = $client->captureException($ex);

// Give the user feedback
echo "Sorry, there was an error!";
echo "Your reference ID is " . $event_id;

For more information, see our documentation.

Integration with frameworks

Other packages exists to integrate this SDK into the most common frameworks.

Official integrations

The following integrations are fully supported and maintained by the Sentry team.

3rd party integrations

The following integrations are available and maintained by members of the Sentry community.

Nette
ZendFramework
WordPress
Drupal
OpenCart
Magento2
October CMS
... feel free to be famous, create a port to your favourite platform!

Community

Documentation
Bug Tracker
Code
Mailing List
IRC (irc.freenode.net, #sentry)

Contributing

Dependencies are managed through composer:

$ composer install

Tests can then be run via phpunit:

$ vendor/bin/phpunit

Tagging a Release

Make sure CHANGES is up to date (add the release date) and master is green.
Create a new branch for the minor version (if not present):

$ git checkout -b releases/1.11.x

Update the hardcoded version tag in Client.php:

class Raven_Client
{
    const VERSION = '1.11.0';
}

Commit the change:

$ git commit -a -m "1.11.0"

Tag the branch:

git tag 1.11.0

Push the tag:

git push --tags

Switch back to master:

git checkout master

Add the next minor release to the CHANGES file:

## 1.12.0 (unreleased)

Update the version in Client.php:

class Raven_Client
{
    const VERSION = '1.12.x-dev';
}

Lastly, update the composer version in composer.json:

    "extra": {
        "branch-alias": {
            "dev-master": "1.12.x-dev"
        }
    }

All done! Composer will pick up the tag and configuration automatically.

james-and-james-fulfilment / sentry

Maintainers

Details