born05/craft-sentry

Pushes Craft CMS errors to Sentry.

Maintainers

Details

github.com/born05/craft-sentry

Source

Issues

Documentation

Installs: 128 309

Dependents: 3

Suggesters: 0

Security: 0

Stars: 10

Watchers: 7

Forks: 11

Open Issues: 6

Type:craft-plugin

3.0.0 2024-06-13 12:44 UTC

Requires

MIT b85283a8ce4dd1ed97c032e05293d5a88ab702a4

cmssentryCraftcraftcmscraft-pluginsentry sdk

This package is auto-updated.

Last update: 2024-11-13 13:49:21 UTC

README

Pushes Craft CMS errors to Sentry.

Installation

Plugin Store

  1. Search for 'Sentry SDK'.
  2. Hit install
  3. Create a config file as explained below.

Composer

  1. Run: composer require born05/craft-sentry
  2. Hit install in Admin > Settings > Plugins
  3. Create a config file as explained below.

Requirements

  • Craft 4.0.0 and up
  • PHP 8.0.2 and up

Configuring Sentry

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

<?php

return [
    '*' => [
        'enabled'        => true,
        'anonymous'      => false, // Determines to log user info or not
        'clientDsn'      => getenv('SENTRY_DSN') ?: 'https://example@sentry.io/123456789', // Set as string or use environment variable.
        'clientKey'      => getenv('SENTRY_CLIENT_KEY') ?: 'z987654321a', // https://js.sentry-cdn.com/z987654321a.min.js
        'excludedCodes'  => ['400', '404', '429'],
        'release'        => getenv('SENTRY_RELEASE') ?: null, // Release number/name used by sentry.
        'reportJsErrors' => false,
        'sampleRate'     => 1.0,
        'ignoreErrors'   => [
          // Email link Microsoft Outlook crawler compatibility error
          // cf. https://forum.sentry.io/t/unhandledrejection-non-error-promise-rejection-captured-with-value/14062
          "Non-Error promise rejection captured with value: Object Not Found Matching Id:",
        ]
    ],
];

Credits

Based upon the sentry plugin by Luke Youell.

License

Copyright © Born05

See license