davidsneighbour / sentry-php

The official PHP SDK for Sentry (sentry.io)

Sentry SDK for PHP

Version	Build Status	Code Coverage
master
develop

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.

Install

To install the SDK you will need to be using Composer in your project. To install it please see the docs.

This is our "core" SDK, meaning that all the important code regarding error handling lives here. If you are happy with using the HTTP client we recommend install the SDK like: sentry/sdk

composer require sentry/sdk

This package (sentry/sentry) is not tied to any specific library that sends HTTP messages. Instead, it uses Httplug to let users choose whichever PSR-7 implementation and HTTP client they want to use.

If you just want to get started quickly you should run the following command:

composer require sentry/sentry php-http/curl-client

This is basically what our metapackage (sentry/sdk) provides.

This will install the library itself along with an HTTP client adapter that uses cURL as transport method (provided by Httplug). You do not have to use those packages if you do not want to. The SDK does not care about which transport method you want to use because it's an implementation detail of your application. You may use any package that provides php-http/async-client-implementation and http-message-implementation.

Usage

\Sentry\init(['dsn' => '___PUBLIC_DSN___' ]);

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
• Laravel

3rd party integrations

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

• Drupal
• Flow Framework
• OXID eShop
• WordPress
• ZendFramework
• SilverStripe
• TYPO3
• ... feel free to be famous, create a port to your favourite platform!

3rd party integrations using old SDK 1.x

• Neos CMS
• OpenCart
• TYPO3

Community

• Documentation
• Bug Tracker
• Code

Contributing

Dependencies are managed through composer:

$ composer install

Tests can then be run via phpunit:

$ vendor/bin/phpunit