Sentry is an error and exception aggregation service. It takes your application's errors and stores them for later analysis and debugging.
Imagine this: You see exceptions before your client does. This means the error > report > debug > patch > deploy cycle is the most efficient it can possibly be.
This module binds Sentry.io and locally-hosted Sentry installations, to the error & exception handler of SilverStripe. If you've used systems like RayGun, Rollbar, AirBrake and BugSnag before, you'll know roughly what to expect.
- PHP5.6+, <7.2
- SilverStripe v4.0.0+
- PHP5.4+, <7.0
- SilverStripe v3.1.0+, < 4.0
Add the Composer package as a dependency to your project:
composer require phptek/sentry: 1.x
composer require phptek/sentry: 2.x
Configure your application or site with the Sentry DSN into your project's YML config:
The following YML config will get you errors reported in all environment modes: dev, test and live:
PhpTek\Sentry\Adaptor\SentryClientAdaptor:
opts:
# Example DSN only. Obviously you'll need to setup your own Sentry "Project"
dsn: http://deacdf9dfedb24ccdce1b90017b39dca:[email protected]/44
The following YML config will get you errors reported just in test and live but not dev:
---
Only:
environment: test
---
PhpTek\Sentry\Adaptor\SentryClientAdaptor:
opts:
# Example DSN only. Obviously you'll need to setup your own Sentry "Project"
dsn: http://deacdf9dfedb24ccdce1b90017b39dca:[email protected]/44
---
Except:
environment: test
---
PhpTek\Sentry\Adaptor\SentryClientAdaptor:
opts:
# Example DSN only. Obviously you'll need to setup your own Sentry "Project"
dsn: http://deacdf9dfedb24ccdce1b90017b39dca:[email protected]/44
---
Only:
environment: dev
---
PhpTek\Sentry\Adaptor\SentryClientAdaptor:
opts:
dsn: null
---
Should your app require outgoing traffic to be passed through a proxy, the following config will work.
# Proxy constants
http_proxy:
host: '`MY_OUTBOUND_PROXY`'
port: '`MY_OUTBOUND_PROXY_PORT`'
Note: For ~2.0.0 you'll need to ensure your project's config that includes the Sentry DSN above, is set to be after the module's config, thus:
After: 'sentryconfig'
This is because a baked-in dummy DSN needed to be added to the module's config for unit-testing. This will
need to remain in-place until the tests can be fixed to use the Config system properly.
phptek\Sentry\Adaptor\SentryClientAdaptor:
opts:
# Example DSN only. Obviously you'll need to setup your own Sentry "Project"
dsn: http://deacdf9dfedb24ccdce1b90017b39dca:[email protected]/44
Sentry is normally setup once in your project's YML config or _config.php file. See the usage docs for details and options.
The stacktrace does not show in SilverStripe 4. We're using the Monolog package's RavenHandler which isn't as fully functional.
There is a PR in that fixes the problem here: Seldaek/monolog#1075.
See the TODO docs for more.