Joomla

Plugin for Joomla 4, 5, and 6

Free on every plan, including the free one

Start for free Documentation

Where to get it

View in the extensions directory

Joomla Extensions Directory

Requirements Joomla 4, 5 or 6, PHP 8.2+

Package name PLG_SYSTEM_DOCKRAY

Pricing Free

What it is for

The official DockRay plugin connects Joomla to the monitoring platform and automatically reports unhandled errors and exceptions. Issues that occur while Joomla is running are sent directly to the DockRay dashboard along with the information needed to investigate them.

Error and Performance Information

Reported events can include:

the error type and message,
where the error occurred and the stack trace,
environment and application version information,
context related to the request being processed.

The plugin can also monitor HTTP request processing times and optionally collect JavaScript errors occurring in the browser.

Simple Configuration

You can configure the integration under Plugins → System - DockRay → Options by entering your project token and private key. The configuration can also be defined using PHP constants in the configuration.php file.

Privacy and Developer Features

Sending logged-in user data, IP addresses, and user agents is optional. This allows you to adjust the scope of collected information to your project's requirements and privacy policy.

The plugin also allows you to manually report exceptions from your own PHP code using the DockRay SDK.

Installation

Plugin Installation

Go to System → Install → Extensions.
Select Upload Package File.
Select the plg_system_dockray.zip file and wait for the installation to complete.

Enable the Plugin

Go to System → Plugins.
Search for System - DockRay and enable the plugin.

Configuration

Open System - DockRay → Options.
Enter the project token and private key available in the DockRay dashboard.
Save the configuration.
Click Send a test event to verify the connection to DockRay.

Once configured, DockRay will automatically start reporting supported errors and exceptions.

How to use it

The integration reports exceptions on its own. This is for the reports you send deliberately.

php

<?php

use function Dock\Ray\captureException;

try {
    $model->save($data);
} catch (\Throwable $exception) {
    captureException($exception);

    throw $exception;
}