FORGEBOX Enterprise 🚀 - Take your ColdFusion (CFML) Development to Modern Times! Learn More...

PresideCMS Extension: Sentry error reporting

v3.0.0+0000012 Public

Sentry Integration for Preside

Overview

This extension provides integration with Sentry for the Preside platform.

Installation

The project is registered on forgebox. Using Commandbox, from the root of your application, type the following command:

box install preside-ext-sentry

Usage

Once installed (see below), you will need to configure your Sentry API key for your application. This can be achieved a number of ways:

  • Injecting a configuration variable, SENTRY_API_KEY (recommended). This can be achieved with a regular system environment variable named PRESIDE_SENTRY_API_KEY, or by adding a SENTRY_API_KEY entry to the /application/config/.injectedConfiguration json file
  • Setting an application variable application.SENTRY_API_KEY={yourkey}

As of v3.0.0, the extension supports the new format of Client key which does not include the secret. Old-style Client keys (those containing public:secret) are still supported, although the secret will not be used.

Environments and releases

In addition, you can optionally specify an "application version" (release) and an application "environment" that Sentry can use. This way you are able to distinguish within the same Sentry project different releases and server environments, e.g. production, staging, development, ... Note: Environments are supported as of Sentry version 9.

  • Injecting a configuration variable, SENTRY_ENVIRONMENT (recommended). This can be achieved with a regular system environment variable named PRESIDE_SENTRY_ENVIRONMENT, or by adding a SENTRY_ENVIRONMENT entry to the /application/config/.injectedConfiguration json file

  • Setting an application variable application.SENTRY_ENVIRONMENT={yourenvironment}

  • Injecting a configuration variable, SENTRY_APP_VERSION (recommended). This can be achieved with a regular system environment variable named PRESIDE_SENTRY_APP_VERSION, or by adding a SENTRY_APP_VERSION entry to the /application/config/.injectedConfiguration json file

  • Setting an application variable application.SENTRY_APP_VERSION={yourenvironment}

Dependencies (0)


Dev Dependencies (0)


Changelog

v3.0.0

  • #8 Enable new style API endpoint URLs
  • #7 automatically tag issues with preside version and extension versions that appear in the stack trace
  • #1 add ability to set an 'app_version' that sentry will use for the 'release' field in errors
  • #4 put the tag context / issue trace in the correct order

v2.0.2

  • Version bump

v2.0.1

  • Do not read http request body when not used

v2.0.0

  • Add support for tagging environments
  • Changing reference from _getApiKey() to local variable apiKey in _getSentryClient + removing redundant output=false parameters
  • Removing redundant output=false parameters

v1.0.1 - v1.0.3

  • Build fixes and meta

v1.0.0

Initial release

 

$ box install preside-ext-sentry

No collaborators yet.
     
  • {{ getFullDate("Jan 21 2021 12:01 PM GMT") }}
  • {{ getFullDate("Jan 21 2021 12:01 PM GMT") }}
  • 1,437
  • 993
  • 56,172