thathoff/kirby-sentry

Sentry integration for Kirby 3

3.1.0 2024-01-10 08:52 UTC

Requires

• getkirby/cms: ^3.6.1|^4.0.0
• getkirby/composer-installer: ^1.1
• sentry/sdk: ^3.1

MIT

• Markus Denhoff
• reinorange GmbH

README

This is a plugin for Kirby (> 3.6.1) that logs errors and exceptions to Sentry and other Sentry compatible error trackers (eg. GitLab).

⚠️ Please Note: Kirby versions before 3.6.1 are not supported because the system.exception hook is only available since Kirby 3.6.1.

Installation

With Composer

composer require thathoff/kirby-sentry

Manual Installation

• Download this plugin
• Extract the archive
• Move folder into the site/plugins directory
• Run composer install inside this folder to install the Sentry SDK required by the plugin

Configuration

The following configuration options are available in this plugin. Add them to your site/config/config.php

DSN

This option is required. When not set the plugin is disabled. To obtain the DSN create a new Sentry project of type PHP.

Default: null

'thathoff.sentry.dsn' => "https://[e-mail]/123456",

Environment

You can configure an environment which is sent to sentry. This can be eg. staging or any other string that helps you to identify the environment the error happened in.

Tip: Use Kirby multi environment setup to change this option.

Default: 'production'

'thathoff.sentry.environment' => 'production',

Add User Context

When a Kirby user is logged in, the plugin sends the user’s email address and the user’ name to Sentry to track down errors and exceptions to users.

To disable, set this option to false.

Default: true

'thathoff.sentry.addUserContext' => true,