This plugin will log errors and exceptions in DokuWiki's PHP backend and the JavaScript frontend to a Sentry instance. You can either use sentry.io or a self hosted instance.

Install the plugin using the Plugin Manager and the download URL above, which points to latest version of the plugin. Refer to Plugins on how to install plugins manually.

Privacy Info: when you install this plugin in a live wiki, you probably need to inform your users that their personal information (username, email, IP-Address, browser info) is logged to Sentry in case of an unforeseen error. Sentry also offers some detailed setting to configure how long personal data is retained.

Changes

• Merge pull request #12 from cosmocode/memory (2020-07-02 15:23)
• Version upped (2020-07-02 15:04)
• Fix Travis CI config (2020-07-02 13:08)
• Prevent memory exhaustion in Hogfather (2020-07-02 12:59)
• Version upped (2018-06-12 23:52)
• Merge pull request #7 from cosmocode/jslogs (2018-06-12 14:46)
• reverse javascritp stack traces (2018-06-12 14:34)
• set correct file name field for chrome stacks (2018-06-12 14:34)

Use the extension manager and configure the DSN to you sentry project. You can find it under Project → Settings → Client Keys.

It should look like this: https://<public>:<secret>@<sentryinstance>/<projectid>.

You can configure which kind of errors should be logged via the errors configuration setting. It defaults to what is set for PHP's error_reporting and accepts the same integer. You can use this calculator to figure out the value you want.

The env variable allows you to easily differentiate between multiple wikis being logged into the same Sentry. This is useful when you have a local development and a live wiki for example.

Once installed and configured, it will log all unhandled errors to Sentry automatically.

You can also use it in your code for specialized logging.

To log an error use the helper plugin:

try {
    // some code
} catch(\Exception $e) {
    $sentry = plugin_load('helper', 'sentry');
    if($sentry) $sentry->logException($e);
    msg(hsc($e->getMessage()), -1);
}

The helper plugin exposes some more public methods in case you need more control.

To log an error, call the SentryPlugin.logSentryException() method.

try {
    // some code
} catch(error) {
    window.SentryPlugin && SentryPlugin.logSentryException(error, {});
    console.log(error)
}