digitregroup/grav-plugin-sentry

sentry.io Grav front and back integration

Sentry Plugin

The Sentry Plugin is an extension for Grav CMS.

This plugin provide a sentry.io Grav integration. It is able to automaticaly setup the Sentry SDK in the backend (server side) using de PHP SDK and in the frontend (browser side) using the Javascript SDK.

Installation

Installing the Sentry plugin can be done in one of three ways: The GPM (Grav Package Manager) installation method lets you quickly install the plugin with a simple terminal command, the manual method lets you do so via a zip file, and the admin method lets you do so via the Admin Plugin.

Semi-Automatique Installation

Add the following lines in your user/.dependencies file :

git:
    sentry:
        url: https://github.com/digitregroup/grav-plugin-sentry
        path: user/plugins/sentry
        branch: master

links:
    sentry:
        src: grav-plugin-sentry
        path: user/plugins/sentry
        scm: github

Then simply run the bin/grav install commands.

Manual Installation

To install the plugin manually, 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 may require other plugins to operate, please see its blueprints.yaml-file on GitHub.

Admin Plugin

If you use the Admin Plugin, you can install the plugin directly by browsing the Plugins-menu 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: true
# Main DSN for the backend (Server side) and the frontend (Browser)
dsn: https://[email protected]/xxxxxxx

# Backend configuration
backend:
  enabled: true

  # Override the DSN for the backend (Server side)
  # dsn: https://[email protected]/xxxxxxx

  ### Sentry Init variables
  max_breadcrumbs: 100
  attach_stacktrace: false
  # release:
  # environment:
  # server_name:

  # Predefined error level constant (default | all | error_warning | all_except_notice)
  # error_types: default

  ### Context settings
  tags:
    side: backend

# Frontend configuration
frontend:
  enabled: true

  # Override the DSN for the frontend (browser side)
  # dsn: https://[email protected]/xxxxxxx

  ### Sentry Init variables
  maxBreadcrumbs: 100
  debug: false
  attachStacktrace: false
  # release:
  # environment:
  # serverName:

  ### Context settings
  tags:
    side: frontend

Warning: If you override this config in your environment configuration files, please note than grav does not merge nested variable.

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

Backend error types level constants

Here is all predefined error_types :

• default (or leave it blank/undefined) : E_ALL & ~E_DEPRECATED & ~E_USER_DEPRECATED & ~E_STRICT
• all | 'ALL' : E_ALL
• error_warning | 'ERROR_WARNING' : E_ERROR | E_WARNING | E_PARSE
• all_except_notice | 'ALL_EXCEPT_NOTICE' : E_ALL & ~E_NOTICE

To Do

• Automaticaly catch potentialy logged users and send them into the Sentry context

grav-plugin-sentry's Issues

Update the Changelog

Don't forget to update the changelog...

Add to GPM

This looks like a useful plugin, but it doesn't appear to be registered in GPM?

It would be good to get this added to GPM so that more people find out about it and to make installation easier.