yawik/sentry

This module integrates Sentry error reporting in an YAWIK instance.

Maintainers

Details

github.com/yawik/sentry

Source

Issues

Installs: 110

Dependents: 1

Suggesters: 0

Security: 0

Stars: 0

Watchers: 2

Forks: 0

Open Issues: 1

Type:yawik-module

v0.2.0 2020-12-13 12:39 UTC

This package is auto-updated.

Last update: 2024-05-13 20:27:00 UTC


README

This integrates Sentry error reporting into an YAWIK instance

Requirements

running YAWIK

Installation

Require a dependency via composer.

composer require yawik/sentry

Enable the module for the Zend module manager via creating the sentry.module.php file in the /config/autoload directory with the following content.

<?php
return [
    'YkSentry'
];

Configuration

Copy the file config/sentry.module-options.local.php.dist into the config/autoload directory and strip off the .dist extension.

Adjust the configuration.

  • $enable:
    You may disable sending events to Sentry. (e.g. for testing or development environments.)
  • $sentryConfig:
    You can use any configuration keys that can be used in the function \Sentry\init() as described here.
    However, the dsn key is required, and sending events will be disabled, if it is not set or empty - regardless of the $enabled setting above.
$enable = true;

$sentryConfig = [
    // the DSN (public key) for the sentry server
    'dsn' => '',
];

Development

  1. Clone project
$ git clone git@github.com:yawik/sentry.git /path/to/yawik-sentry
  1. Install dependencies:
$ composer install
  1. Run PHPUnit Tests
$ ./vendor/bin/phpunit

Licence

MIT