Skip to content

pwnyprod/grav-plugin-sentry

Repository files navigation

sentry Plugin

PHP Composer Codeception

The sentry Plugin is for Grav CMS with an option to log 404 Not Found events.

Installation

Installing the sentry plugin can be done in one of two ways. The GPM (Grav Package Manager) installation method enables you to quickly and easily install the plugin with a simple terminal command, while the manual method enables you to do so via a zip file.

GPM Installation (Preferred)

The simplest way to install this plugin is via the Grav Package Manager (GPM) through your system's terminal (also called the command line). From the root of your Grav install type:

bin/gpm install sentry

This will install the sentry plugin into your /user/plugins directory within Grav. Its files can be found under /your/site/grav/user/plugins/sentry.

Manual Installation

To install this plugin, just download the zip version of this repository and unzip it under /your/site/grav/user/plugins. Then, rename the folder to sentry. You can find these files on GitHub or via GetGrav.org.

You should now have all the plugin files under

/your/site/grav/user/plugins/sentry

NOTE: This plugin is a modular component for Grav which requires Grav and the Error and Problems to operate.

Admin Plugin

If you use the admin plugin, you can install directly through the admin plugin by browsing the Plugins tab and clicking on the Add button.

Configuration

Before configuring this plugin, you should copy the user/plugins/sentry/sentry.yaml to user/config/plugins/sentry.yaml and only edit that copy.

Here is the default configuration and an explanation of available options:

    enabled: false
    dns_link: 
    log_not_found: true
    error_types: 6143
    excluded_exceptions: ''
  • dns_link (required): Your Sentry DSN Link to the Project.
  • log_not_found (required): Set to true if you wish sentry to log invalid url access.
  • error_types (optional): The integer value of the php error reporting level that sentry will use to log errors. Default value is 6143(E_ALL & ~E_DEPRECATED & ~E_STRICT & ~E_USER_DEPRECATED) If this value is not set the SDK will fallback to 32767(E_ALL)
  • excluded_exceptions (optional): Comma-separated exception class names that sentry will ignore(whitelist). All exceptions are logged by default. Sample value: 'Grav\Common\Data\ValidationException,Grav\Framework\RequestHandler\Exception\NotFoundException'

Note that if you use the admin plugin, a file with your configuration, and named sentry.yaml will be saved in the user/config/plugins/ folder once the configuration is saved in the admin.

Usage

  • Install the Plugin
  • Insert your DNS Link from Sentry Project
  • Activate Plugin
  • Profit

Credits

About

Grav Plugin for Sentry Bugtracker Integration

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages