WordPress Sentry

Description

This plugin can report PHP errors (optionally) and JavaScript errors (optionally) to Sentry and integrates with its release tracking.

It will auto detect authenticated users and add context where possible. All context/tags can be adjusted using filters mentioned below.

Filters

This plugin provides filters to plugin/theme developers.

For more information have a look at the README.md file: https://github.com/stayallive/wp-sentry/blob/master/README.md#filters.

Contributors

See: github.com/stayallive/wp-sentry/graphs/contributors

Installation

  1. Install this plugin by cloning or copying this repository to your wp-contents/plugins folder
  2. Configure your DSN as explained below
  3. Activate the plugin through the WordPress admin interface

Note: this plugin does not do anything by default and has no admin interface. A Sentry DSN must be configured.

(Optionally) track PHP errors by adding this snippet to your wp-config.php and replace PHP_DSN with your actual DSN that you find in Sentry:

define( 'WP_SENTRY_DSN', 'PHP_DSN' );

Note: Do not set this constant to disable the PHP tracker.

(Optionally) set the error types the PHP tracker will track:

define( 'WP_SENTRY_ERROR_TYPES', E_ALL & ~E_DEPRECATED & ~E_NOTICE & ~E_USER_DEPRECATED );

(Optionally) If this flag is enabled, certain personally identifiable information is added by active integrations. Without this flag they are never added to the event, to begin with.

If possible, it’s recommended to turn on this feature and use the server side PII stripping to remove the values instead.

When enabled the current logged in user and IP address will be added to the event.

define( 'WP_SENTRY_SEND_DEFAULT_PII', true );

(Optionally) track JavaScript errors by adding this snippet to your wp-config.php and replace JS_DSN with your actual public DSN that you find in Sentry (never use your private DSN):

define( 'WP_SENTRY_PUBLIC_DSN', 'JS_DSN' );

Note: Do not set this constant to disable the JavaScript tracker.

(Optionally) define a version of your site; by default the theme version will be used. This is used for tracking at which version of your site the error occurred. When combined with release tracking this is a very powerful feature.

define( 'WP_SENTRY_VERSION', 'v3.0.4' );

(Optionally) define an environment of your site. Defaults to unspecified.

define( 'WP_SENTRY_ENV', 'production' );

Reviews

Read all 5 reviews

Contributors & Developers

“WordPress Sentry” is open source software. The following people have contributed to this plugin.

Contributors

Translate “WordPress Sentry” into your language.

Interested in development?

Browse the code, check out the SVN repository, or subscribe to the development log by RSS.

Changelog

3.0.4

  • Fixed error when WP_SENTRY_VERSION is not defined and theme version returns false.
  • Update PHP SDK to version 2.2.2

3.0.3

  • Use the ABSPATH constant as default project root.

3.0.2

  • Show a notice that we only support PHP 7.1+ instead of letting 7.1 code break the site.

3.0.1

  • Just a version bump because a version number was not correctly updated.

3.0.0

Note: This is a breaking release for both the PHP SDK and the Browser SDK, please test it well and read the migration guides if applicable before upgrading!

If you are doing anything more than just have this plugin installed and a DSN defined on your wp-config.php, check out the upgrade docs:

  • PHP SDK: https://github.com/getsentry/sentry-php/blob/master/UPGRADE-2.0.md
  • Browser SDK: https://github.com/getsentry/sentry-javascript/blob/master/MIGRATION.md#upgrading-from-4x-to-5x

Becasue of the upgrade to the 2.x version of the PHP SDK this plugin now has the requirement that it runs on at least PHP 7.1, for older PHP versions stick to version 2.x.

  • Update PHP SDK to version 2.2.1
  • Update Sentry Browser to version 5.6.3

2.8.0

  • Update Sentry Browser to version 4.6.6

2.7.2

  • Remove unneeded files from the plugin download

2.7.1

  • Fix IE compatibility for JS integration
  • Update Sentry Browser to version 4.5.0

2.7.0

This release might contain breaking changes if you are using the wp_sentry_public_options filter.

  • Update wp_sentry_public_options filter to support the Sentry Browser SDK better (#28)
  • Update Sentry Browser to version 4.4.2
  • Update Raven PHP to version 1.10.0

2.6.1

  • Update Sentry Browser to version 4.3.2

2.6.0

If you are doing custom calls to Sentry from your front-end make sure you check out the new docs and migration instructions: https://github.com/getsentry/sentry-javascript/releases/tag/4.0.0

If you are not doing anything custom to the JS side of the SDK you can safely upgrade to this version.

  • Upgrade Raven JS to Sentry Browser version 4.2.3
  • Tested on WordPress 5.0

2.5.0

  • Update Raven JS to version 3.27.0
  • Update Raven PHP to version 1.9.2

2.4.0

  • Update Raven JS to version 3.26.3
  • Update Raven PHP to version 1.9.1

This version allows the usage of the new private key-less DSN introduced in Sentry 9.

2.3.0

  • Update Raven JS to version 3.24.2
  • Update Raven PHP to version 1.9.0

2.2.0

  • Change minimum PHP requirement to 5.4

2.1.5

  • “Fix” PHP 5.3 support (this will be the last version supporting PHP 5.3)
  • Update Raven JS to version 3.22.0

2.1.4

  • Update Raven JS to version 3.21.0
  • Update Raven PHP to version 1.8.2

2.1.3

  • Tested up to WordPress 4.9
  • Update Raven PHP to version 1.8.1

2.1.2

  • Update Raven PHP to version 1.8.0

2.1.0

  • Switch to a composer based plugin setup (@LeoColomb)
  • Update Raven JS to version 3.19.1

2.0.18

  • Update Raven PHP to version 1.7.1 (@ikappas)
  • Update Raven JS to version 3.17.0 (@ikappas)

2.0.17

  • Update Raven JS to version 3.16.0
  • Update documentation on how to use as a mu-plugin

2.0.16

  • Update Raven JS to version 3.15.0 (@hjanuschka)
  • Update Raven PHP to version 1.7.0

2.0.15

  • Update Raven JS to version 3.13.1

2.0.14

  • Update Raven JS to version 3.13.0

2.0.13

  • Update Raven JS to version 3.12.0

2.0.12

  • Allow the error_types option to be configured from wp-config.php
  • Fire the wp_sentry_options after the after_setup_theme action if it’s defined

2.0.11

  • Update Raven JS to version 3.11.0

2.0.10

  • Update Raven JS to version 3.10.0 (@ikappas)

2.0.9

  • Update Raven PHP to version 1.6.2 (@mckernanin)

2.0.8

  • Fix setting the context on the JS SDK

2.0.7

  • Update Raven JS to version 3.9.1

2.0.6

  • Update Raven JS to version 3.9.0

2.0.4

  • Re-release to fix SVN issues

2.0.0

  • Complete rewrite of the plugin for better integration (@ikappas)
  • Updated Raven JS tracker to version 3.8.0 (@ikappas)

1.0.1

  • Fix WP_SENTRY_VERSION already defined error (@ikappas)

1.0.0

  • Initital release