WordPress Sentry
Alex Bouma By Alex Bouma

July 14, 2024

WordPress Sentry Plugin

A (unofficial) WordPress plugin to report PHP errors and Browser (JavaScript) errors to Sentry.

This plugin can report PHP errors and Browser (JavaScript) errors to Sentry.

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

For more information and documentation have a look at the full documentation.

Contributors

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

Installation

It is recommended to use the plugins interface in WordPress to install this plugin.

If manual installation is required, please make sure that the plugin files are in a folder named “wp-sentry-integration” in the WordPress plugins folder, usually “wp-content/plugins”.

To start using the plugin first setup the DSN for either the PHP side or the Browser side or both.

All other configuration options are optional but it’s advised you read through them to see if any are applicable to you or are thing you’d like to configure.

You can find more information and the full documentation: here. The following are the basics.

Note: When configuring constants in your wp-config.php do this before the That's all, stop editing! Happy publishing. line, otherwise they won’t work!

Note: this plugin does not do anything by default and has only a admin interface to test the integration and view it’s configuration. A Sentry DSN must be configured in your wp-config.php.

Sentry uses something called a DSN (read more) to configure the SDK.

To track PHP errors add this snippet to your wp-config.php and replace PHP_DSN with your actual DSN that you find inside Sentry in the project settings under “Client Keys (DSN)”:

define( 'WP_SENTRY_PHP_DSN', 'PHP_DSN' );

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

To track Browser (JavaScript) errors add this snippet to your wp-config.php and replace JS_DSN with your actual DSN that you find inside Sentry in the project settings under “Client Keys (DSN)”:

define( 'WP_SENTRY_BROWSER_DSN', 'JS_DSN' ); // You can _optionally_ enable or disable the JavaScript tracker in certain parts of your site with these constants: define('WP_SENTRY_BROWSER_ADMIN_ENABLED', true); // Add the JavaScript tracker to the admin area. Default: true define('WP_SENTRY_BROWSER_LOGIN_ENABLED', true); // Add the JavaScript tracker to the login page. Default: true define('WP_SENTRY_BROWSER_FRONTEND_ENABLED', true); // Add the JavaScript tracker to the front end. Default: true

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

You can find more information and the full documentation: here. The above are the basics.

Changelog

7.21.0

  • Add actions to safely capture exceptions and messages, read more about how to use here
  • Show query callstack as reversed array instead of string for spans and breadcrumbs
  • When tracing wrap spans in theme.setup and plugins.setup if possible
  • Better transaction name for search page when tracing

7.20.0

  • Fix Excimer classes being incorrectly prefixed making profiling unusable (#198)

7.19.0

  • Do not set “anonymous” as user when no user is authenticated (and WP_SENTRY_SEND_DEFAULT_PII is set to true)

7.18.0

  • Normalize placeholder names in the tracing transaction
  • Preserve leading / in tracing transaction when parsing the matched URL

7.17.4

  • Fixed warning on admin page because of variable name typo (#196, thanks @leadoux)

7.17.3

  • Fixed error resolving the action being performanced by admin-ajax.php when tracing (#195)

7.17.2

  • Fixed error with extracting transient keys in transient tracing

7.17.1

  • Fixed error when enabling PHP tracing (#194)

7.17.0

This release adds performance tracing and profiling support for the PHP SDK, this feature is disabled by default read the documentation on how to enable it.

  • Update Sentry Browser to version 7.118.0

7.16.0

  • Update PHP SDK to version 4.8.0

7.15.0

This update bumps the minimum PHP version to 7.2.5, this used to be 7.2.0.
This is unlikely to affect you, but if you are still running PHP 7.2.0 you should upgrade to at least 7.2.5.
The change was made to allow upgrading some libraries and prevent deprecation warnings on newer PHP versions.

  • Bump minimum PHP version to 7.2.5

7.14.0

  • Update Sentry Browser to version 7.116.0

7.13.0

  • Fix not returning $options in wp_sentry_options filter (#183, thanks @Pluuk)
  • Update Sentry Browser to version 7.112.2

7.12.0

  • Update PHP SDK to version 4.7.0
  • Update Sentry Browser to version 7.109.0

7.11.0

  • Update Sentry Browser to version 7.108.0

7.10.0

  • Update PHP SDK to version 4.6.1
  • Update Sentry Browser to version 7.107.0

7.9.0

  • Replace polyfill.io with cdnjs, more info. The polyfill was only loaded when the WP_SENTRY_BROWSER_USE_ES5_BUNDLES option was enabled.

7.8.0

  • Add new wp_sentry_before_send filter to allow modifying or discarding a PHP error event before it’s sent to Sentry (#180, thanks @herewithme)
  • Update Sentry Browser to version 7.103.0

7.7.0

  • Update PHP SDK to version 4.6.0
  • Update Sentry Browser to version 7.101.0

7.6.0

  • Update Sentry Browser to version 7.100.0

7.5.1

  • Fix the rendering of installation instructions on the WordPress plugin directory

7.5.0

  • Update PHP SDK to version 4.5.0
  • Update Sentry Browser to version 7.98.0

7.4.0

  • Update Sentry Browser to version 7.94.1

7.3.1

  • Update browser bundles to contain changes from 7.3.0

7.3.0

  • Browser: Call wp_sentry_hook after setting up the integrations to allow the user modifying the integrations array from the hook

7.2.1

  • Fix using is_plugin_active_for_network unconditionally which is not always available

7.2.0

  • Update PHP SDK to version 4.3.1
  • Update Sentry Browser to version 7.91.0
  • Improve handling of the default version especially when in a network environment using a child theme (#171)

7.1.0

  • Update PHP SDK to version 4.0.1
  • Update Sentry Browser to version 7.80.0

7.0.0

Note: This is a breaking release for the PHP 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 configured in your wp-config.php, check out the upgrade docs:

  • PHP SDK: https://github.com/getsentry/sentry-php/blob/master/UPGRADE-4.0.md

  • Update PHP SDK to version 4.0.0

  • Update Sentry Browser to version 7.77.0

6.28.0

  • Update PHP SDK to version 3.22.0
  • Update Sentry Browser to version 7.76.0

6.27.0

  • Update Sentry Browser to version 7.74.0

6.26.0

  • Update Sentry Browser to version 7.73.0
  • Improved admin tools page with documentation links and a more clear layout

6.25.0

  • Update Sentry Browser to version 7.70.0

6.24.0

  • Update PHP SDK to version 3.21.0
  • Update Sentry Browser to version 7.67.0

6.23.0

  • Update Sentry Browser to version 7.60.0

6.22.1

  • Update Sentry Browser to version 7.59.3

6.22.0

  • Update Sentry Browser to version 7.59.1

6.21.0

  • Default Sentry release to current theme version

6.20.0

  • Update PHP SDK to version 3.20.1
  • Update Sentry Browser to version 7.57.0

6.19.0

  • Update Sentry Browser to version 7.56.0

6.18.1

  • Update Sentry Browser to version 7.55.2

6.18.0

  • Update Sentry Browser to version 7.55.0

6.17.0

  • Update Sentry Browser to version 7.54.0

6.16.0

  • Update PHP SDK to version 3.19.1
  • Update Sentry Browser to version 7.53.1

6.15.0

  • No longer rely on the WP_HTTP_Proxy class to configure the HTTP proxy, this allows you to initialize the SDK before WordPress is fully loaded
  • Add WP_SENTRY_BROWSER_FRONTEND_ENABLED, WP_SENTRY_BROWSER_ADMIN_ENABLED and WP_SENTRY_BROWSER_LOGIN_ENABLED constants to enable/disable the browser SDK on the frontend, admin and login pages respectively (they are enabled by default)
  • Update PHP SDK to version 3.18.2
  • Update Sentry Browser to version 7.52.1

6.14.0

  • Update PHP SDK to version 3.18.0
  • Update Sentry Browser to version 7.51.2

6.13.0

  • Update PHP SDK to version 3.17.0
  • Update Sentry Browser to version 7.49.0

6.12.0

  • Update Sentry Browser to version 7.46.0
  • Allow regexes to be used in the new ignoreTransactions option of the browser SDK

6.11.0

If you are using an HTTP proxy in WordPress but don’t want Sentry to use it you should configure WP_PROXY_BYPASS_HOSTS to include the Sentry domain.

6.10.0

  • Add WP_SENTRY_BROWSER_REPLAYS_SESSION_SAMPLE_RATE and WP_SENTRY_BROWSER_REPLAYS_ON_ERROR_SAMPLE_RATE options to enable browser session replays
  • Add WP_SENTRY_BROWSER_SESSION_REPLAY_OPTIONS to configure options passed to new Replays() when browser session replays are enabled
  • Add WP_SENTRY_BROWSER_TRACING_OPTIONS to configure options passed to new BrowserTracing() when browser tracing is enabled
  • Allow regexes to be used in the ignoreErrors option of the browser SDK

6.9.0

  • Update PHP SDK to version 3.16.0
  • Update Sentry Browser to version 7.45.0

6.8.0

  • Update PHP SDK to version 3.14.0
  • Update Sentry Browser to version 7.41.0

6.7.0

  • Update PHP SDK to version 3.13.1
  • Update Sentry Browser to version 7.37.2

6.6.0

  • Update PHP SDK to version 3.12.1
  • Update Sentry Browser to version 7.34.0

6.5.0

  • Update Sentry Browser to version 7.28.0

6.4.0

  • Update Sentry Browser to version 7.26.0

6.3.0

  • Update Sentry Browser to version 7.24.2

6.2.0

  • Update PHP SDK to version 3.12.0
  • Update Sentry Browser to version 7.23.0

6.1.0

  • Update PHP SDK to version 3.9.1
  • Update Sentry Browser to version 7.16.0

6.0.0

Note: This is a breaking release for the Browser/JavaScript SDK

Since 5.0.0 of this plugin, which bundles the Browser SDK version 7, the whitelistUrls and blacklistUrls are no longer working. They are renamed to allowUrls and denyUrls respectively, please update your code if you are using those options.

Since this version of the plugin we no longer bundle the ES5 versions of the Browser SDK by default, which means that if you still need to support older browsers (Internet Explorer 11 mainly) you need to enable the new WP_SENTRY_BROWSER_USE_ES5_BUNDLES option by setting it to true. Enabling the ES5 bundles will also loads an externally hosted polyfill library for the needed polyfills.

If you are still on a WP Sentry version older than version 5.0.0 don’t forget to see the Browser SDK v7 migration guide.

  • Browser: Bundle ES6 compiled browser SDK by default
  • Browser: Introduce new WP_SENTRY_BROWSER_USE_ES5_BUNDLES flag to enable ES5 bundles + external hosted polyfill library
  • Browser: Fix broken whitelistUrls and blacklistUrls which are now called allowUrls and denyUrls options (thanks @dr5hn)

5.2.0

  • Update PHP SDK to version 3.7.0
  • Update Sentry Browser to version 7.10.0
  • Fix potential error when using wp_sentry_options filter when no DSN is set

5.1.0

  • Update PHP SDK to version 3.6.0
  • Update Sentry Browser to version 7.2.0

5.0.0

Note: This is a breaking release for the Browser/JavaScript SDK, please test it well and read the migration guides if applicable before upgrading!
Note: The v7 version of the JavaScript SDK requires a self-hosted version of Sentry 20.6.0 or higher. If you are using a version of self-hosted Sentry (aka onpremise) older than 20.6.0 then you will need to upgrade.

Version 7 of the Sentry JavaScript SDK brings a variety of features and fixes including bundle size and performance improvements, brand new integrations, support for the attachments API, and key bug fixes.
This release does not change or remove any top level public API methods (captureException, captureMessage), and only requires changes to certain configuration options or custom clients/integrations/transports.
For detailed overview of all the changes, please see the v7 migration guide.

  • Update Sentry Browser to version 7.1.1

4.18.0

  • Update PHP SDK to version 3.5.0

4.17.0

  • Fix Sentry Browser context (thanks @giilby)
  • Update Sentry Browser to version 6.19.7

4.16.0

  • Update Sentry Browser to version 6.19.3
  • Bump version of bundled guzzlehttp/psr7 dependency (https://github.com/advisories/GHSA-q7rv-6hp3-vh96)

4.15.0

  • Update PHP SDK to version 3.4.0
  • Update Sentry Browser to version 6.18.2

4.14.0

4.13.1

  • The plugin is now tested on WordPress 5.9

4.13.0

  • Update PHP SDK to version 3.3.7
  • Update Sentry Browser to version 6.17.2
  • Fix possible undefined index notice on admin page

4.12.0

  • Update PHP SDK to version 3.3.6
  • Use WPINC constant instead of hardcoded path to wp-includes

4.11.0

  • Update PHP SDK to version 3.3.5
  • Update Sentry Browser to version 6.16.1

4.10.3

  • Fix possible composer autoloader conflict with Sentry SDK helpers file

4.10.2

  • Fix problem loading plugin in wp-config.php with browser DSN enabled

4.10.1

  • Fix Interface 'Stringable' not found on PHP < 8.0
  • Fix problem loading plugin in wp-config.php without WP_SENTRY_VERSION defined

4.10.0

  • Allow loading the plugin from wp-config.php before WordPress is loaded (see documentation) (thanks @ocean90)
  • Add support for modifying the Sentry PHP SDK ClientBuilder builder (see documentation)

4.9.0

  • Update Sentry Browser to version 6.15.0

4.8.0

  • Update PHP SDK to version 3.3.4
  • Update Sentry Browser to version 6.14.1

4.7.0

  • Update PHP SDK to version 3.3.3
  • Update Sentry Browser to version 6.13.2

4.6.0

  • Update PHP SDK to version 3.3.2
  • Update Sentry Browser to version 6.11.0

4.5.0

  • Update Sentry Browser to version 6.8.0

4.4.1

  • Update PHP SDK to version 3.3.1
  • Update Sentry Browser to version 6.7.2

4.4.0

  • Update PHP SDK to version 3.3.0
  • Update Sentry Browser to version 6.7.0

4.3.0

  • Update PHP SDK to version 3.2.1
  • Update Sentry Browser to version 6.3.4

4.2.0

  • Update PHP SDK to version 3.1.5
  • Update Sentry Browser to version 6.2.0

4.1.1

  • Allow overwriting the integrations array using the JavaScript wp_sentry_hook callback

4.1.0

  • Add WP_SENTRY_BROWSER_TRACES_SAMPLE_RATE option to enable browser performance tracing
  • Update PHP SDK to version 3.1.4
  • Update Sentry Browser to version 6.1.0

4.0.1

Rereleased 4.0.0 to fix issue with missing dependencies folder, see 4.0.0 changelog for changes!

4.0.0

Note: This is a breaking release for the PHP 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-3.0.md

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

  • Drop PHP 7.1 support and add PHP 8.0 support
  • Update PHP SDK to version 3.1.3
  • Update Sentry Browser to version 6.0.3

3.11.1

  • Fix missing files in the release

3.11.0

  • Update PHP SDK to version 2.5.0
  • Update Sentry Browser to version 5.27.3

3.10.0

  • Update PHP SDK to version 2.4.2
  • Update Sentry Browser to version 5.20.0

3.9.0

  • Update PHP SDK to version 2.4.1
  • Update Sentry Browser to version 5.19.2

3.8.0

  • Update Sentry Browser to version 5.18.1
  • Admin test page will now show for users with the activate_plugins capability (instead of install_plugins) to support sites that have install_plugins disabled globally
  • Rename public/sentry-browser-<Sentry Browser version>.min.js to public/wp-sentry-browser.min.js, this change should have no user impact unless you manually include that file
  • Renamed WP_SENTRY_DSN to WP_SENTRY_PHP_DSN, both will be supported but the latter is preferred because of it’s more descriptive name
  • Renamed WP_SENTRY_PUBLIC_DSN to WP_SENTRY_BROWSER_DSN, both will be supported but the latter is preferred because of it’s more descriptive name

3.7.0

  • Update PHP SDK to version 2.4.0
  • Update Sentry Browser to version 5.17.0

3.6.0

  • Update Sentry Browser to version 5.15.5
  • Added a way to filter the Browser SDK options and/or disable loading the Browser SDK using JavaScript (https://github.com/stayallive/wp-sentry/blob/v3.6.0/README.md#advanced-client-side-hook)

3.5.1

  • Fix scope data (user context & tags etc.) being lost when set before the after_setup_theme hook

3.5.0

  • Remove undocumented WP_SENTRY_PROJECT_ROOT option
  • Set a default for prefixes to get cleaner file paths on PHP stack traces

3.4.6

  • Fix the Monolog namespace being incorrectly scoped causing errors when using the \Sentry\Monolog\Handler class

3.4.5

  • Fix Call to undefined function getallheaders() error on PHP versions below 7.3

3.4.4

  • Remove extra files from WordPress plugin release
  • Fix fatal error caused by composer autoloader when including Sentry sources in other composer autoloader

3.4.3

  • Fix fatal error caused by composer autoloader conflicts with other plugins

3.4.2

  • Add button to admin page to test JavaScript integration

3.4.1

Important: In this release we start using a process to prefix our dependencies to prevent conflicts with other WordPress plugins.
This should cause no problems, but if they do please open up a support ticket or GitHub issue with details about your environment.

  • Fixes issue in build process causing missing files in 3.4.0

3.4.0

Important: In this release we start using a process to prefix our dependencies to prevent conflicts with other WordPress plugins.
This should cause no problems, but if they do please open up a support ticket or GitHub issue with details about your environment.

  • Update PHP SDK to version 2.3.2
  • Update Sentry Browser to version 5.15.4

3.3.0

  • Update PHP SDK to version 2.3.1
  • Update Sentry Browser to version 5.12.4

3.2.0

  • Add admin page (Tools > WP Sentry) to test if the Sentry integration is enabled and working (props @federicobond)

3.1.0

  • Update PHP SDK to version 2.2.6
  • Update Sentry Browser to version 5.10.2

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
Download

Details

  • Version: 7.21.0
  • Active installations: 10,000
  • WordPress Version: 4.4
  • Tested up to: 6.6.1
  • PHP Version: 7.2.5

Ratings


5 Stars
4 Stars
3 Stars
2 Stars
1 Stars

Tags