Debug Plugin

Introduction

The JUMP Debug Plugin provides Sentry and DebugBar integration with your October application.

The plugin also supplied a custom ExceptionHandler used to determine what should be sent to Sentry or not. It includes the additional handling of HTTP Status 410 (Gone) pages and Model Not Found Exceptions.

This ExceptionHandler is already registered if you have forked your project from our Base October Image. See the bootstrap/app.php file for reference.

Installation

Type composer require jump/oc-debug-plugin into your project root terminal.

Repository

Github

Configuration

Debug Bar

To enable the Debug Bar ensure Debug Mode is on:

.env

APP_DEBUG=true

Ensure the Debug Bar itself is enabled:

.env

DEBUGBAR_ENABLED=true

And finally, ensure you are logged into the backend of the October CMS.

Sentry

Ensure you have created a Project on the Sentry Website.

Proceed to the Project Settings and find the DSN Client Key (Currently at SDK Setup > Client Keys(DSN) > DSN).

Paste this value in your .env file:

.env

SENTRY_DSN=https://example-dsn-value.ingest.sentry.io/example

Then simply throw an error in your project and check the Sentry website has received it.