plenta/contao-mimir

Send exceptions within your Contao installation directly to your Slack workspace.

v1.4 2024-12-02 09:36 UTC

Requires

• php: ^8.1
• contao/conflicts: @dev
• contao/core-bundle: ^4.13.0 || ^5.1
• doctrine/dbal: ^2.10.1 || ^3.2.0
• symfony/http-client: ^5.4 || ^6.0

Requires (Dev)

• contao/manager-bundle: ^5.1
• contao/test-case: ^4.4.0
• friendsofphp/php-cs-fixer: ^3.2
• phpunit/phpunit: ^9.5.10
• symfony/phpunit-bridge: v5.3.8

LGPL-3.0-or-later

• Plenta.io

README

Mimir watches over your code and sends any exception he encounters directly to your Slack workspace.

Installation

Install using Contao Manager

Search for slack or exception and you will find this extension.

Install using Composer

composer require plenta/contao-mimir

Setup

1. Set up a Slack webhook (See Slack API documentation).
2. Install Mimir.
3. Configure Mimir

Configuration

Exception white- and blacklisting

There are some exceptions you commonly don't want to be notified about because they don't mean there's something wrong with your code (e.g. Contao's RedirectResponseExceptions). These exceptions are blacklisted by default. You can, however, whitelist them if you want to be notified about them. You can also blacklist exceptions you don't want to be notified about.

Configuration

You can easily configure Mimir through your parameters.yml:

plenta_mimir:
  webhook: 'YourWebhookURL' # required
  exceptions: # optional
    whitelist:
      - 'Full/Exception/Class/Name'
    blacklist:
      - 'Full/Exception/Class/Name'
  debug: true # optional - Default false - Set to true if you want to receive messages in debug environment

System requirements

• PHP: ^8.1
• Contao: ^4.13 || ^5.1 (and later)