Error tracking that helps developers monitor and fix crashes in real time. Iterate continuously. Boost efficiency. Improve user experience.
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
resources/img
src
.gitignore
CHANGELOG.md
LICENSE.md
README.md
composer.json

README.md

icon

Sentry plugin for Craft CMS 3.x

Error tracking that helps developers monitor and fix crashes in real time. Iterate continuously. Boost efficiency. Improve user experience.

Screenshot

Requirements

This plugin requires Craft CMS 3.0.0-RC11, or later.

Installation

To install the plugin, follow these instructions.

  1. Open your terminal and go to your Craft project:

     cd /path/to/project
    
  2. Then tell Composer to load the plugin:

     composer require lukeyouell/craft-sentry
    
  3. In the Control Panel, go to Settings → Plugins and click the “Install” button for Sentry.

Configuring Sentry

Upon successful installation you will be required to supply an authentication token with project:read enabled.

Authentication tokens are available here.

A Sentry account is required, if you don't already have one click here to create one.

Free & paid plans are available.

Using Sentry

After entering your Sentry authentication token, you will be required to select a Project along with a corresponding Client DSN.

Overriding Plugin Settings

If you create a config file in your config folder called sentry.php, you can override the plugin’s settings in the Control Panel. Since that config file is fully multi-environment aware, this is a handy way to have different settings across multiple environments.

Here’s what that config file might look like along with a list of all of the possible values you can override.

<?php

return [
    'enabled'       => true,
    'authToken'     => '',
    'project'       => '',
    'clientDsn'     => '',
    'excludedCodes' => '',
];

Setting enabled to false will stop the plugin from capturing exceptions and reporting them to Sentry.

Sentry Roadmap

Some things to do, and ideas for potential features:

  • Create project from within the CP

Brought to you by Luke Youell