statikbe/craft-sentry

Sentry.io integration for Craft CMS

Maintainers

Details

github.com/statikbe/craft-sentry

Source

Issues

Documentation

Installs: 9 882

Dependents: 1

Suggesters: 0

Security: 0

Stars: 2

Watchers: 10

Forks: 1

Open Issues: 1

Type:craft-plugin

5.1.1 2024-10-17 08:50 UTC

Requires

Requires (Dev)

MIT 31a73e59016e37167c2db079275239c78162cdf2

cmssentryCraftcraftcmscraft-plugincraft sentry

This package is auto-updated.

Last update: 2024-12-17 09:12:52 UTC

README

Sentry.io integration for Craft CMS. Inspired by born05/craft-sentry, but with our own twist.

Installation

To install the plugin, follow these instructions in your terminal.

cd /path/to/project
composer require statikbe/craft-sentry
./craft plugin/install craft-sentry

Configration

Create a config/craft-sentry.php config file with the following contents:

<?php

return [
    'enabled'       => true,
    'anonymous'     => true,
    'clientDsn'     => getenv('SENTRY_DSN') ?: 'https://example@sentry.io/123456789',
    'excludedCodes' => ['400', '404', '429'],
    'excludedExceptions' => [],
    'release'       => getenv('SENTRY_RELEASE') ?: null,
];

Usage

To let Sentry log your exception, you don't really need to do anything. Install the plugin and add your DSN and you're set.

When you're writing your own custom code and throwing your own exception, you'll also want to catch those and send them to Sentry. That can be done like this:

<?php

use statikbe\sentry\Sentry;
use yii\base\InvalidConfigException; // Don't copy this line, it's just here to make the example theoractically correct ;) 

try {
    throw new InvalidConfigException("Something went wrong here...");
} catch (Exception $e) {
    Sentry::handleException($e);
}

The plugin works for exceptions thrown in web requests as well as console requests. For web requests, the url where the error happened is included.

Excluding specific exceptions

Using the excludedExceptions, you can stop specific types of exceptions from being logged to Sentry, for example:

'excludedExceptions' => [
    \craft\errors\ImageTransformException::class,
],

Brought to you by Statik.be