TYPO3 Reports

Extension key: reports
Package name: typo3/cms-reports
Version: 13.4
Language: en
Author: TYPO3 contributors
License: This document is published under the Creative Commons BY 4.0 license.
Rendered: Tue, 14 Apr 2026 11:03:07 +0000

This extension shows status reports and installed services in the System > Reports backend module.

Introduction

Written for new users, this chapter introduces the module Reports and what it does.

Installation

Explains how to install the extension if it is not installed yet.

API Reference

Explains the underlying API and its interfaces.

Custom reports

Introduction into developing your own custom reports or status messages.

Scheduler task

Use the system extension scheduler to configure automatic status reports sent via email.

Introduction

What does it do?

The TYPO3 system extension EXT:reports displays the extendable backend module System > Reports for users with administrator role.

The Reports module groups several system reports and gives you a quick overview about important system statuses and site parameters.

Section "Security"

From a security perspective, the section Security should be checked regularly: it provides information about the administrator user account, encryption key, file deny pattern, Admin Tools checks and more.

Warning

In case of a compromised system, the information displayed here may have been manipulated by the attacker.

Thus, if no problems are pointed out - it does not necessarily mean that there are no security issues. But, on the other hand, if security problems are pointed out, you most certainly should fix them.

Installation

This extension is part of the TYPO3 Core, but not installed by default.

Table of contents

Installation with Composer

Check whether you are already using the extension with:

composer show | grep reports

This should either give you no result or something similar to:

typo3/cms-reports       v12.4.11

If it is not installed yet, use the composer require command to install the extension:

composer require typo3/cms-reports

The given version depends on the version of the TYPO3 Core you are using.

Installation without Composer

In an installation without Composer, the extension is already shipped but might not be activated yet. Activate it as follows:

In the backend, navigate to the Admin Tools > Extensions module.
Click the Activate icon for the Reports extension.

Extension manager showing Reports extension

API

Contents:

ReportInterface

Classes implementing this interface are registered automatically as reports in the module Reports if autoconfigure is enabled in Services.yaml or if it was registered manually by the tag reports.report.

If information from the current request is required for the report use \TYPO3\CMS\Reports\RequestAwareReportInterface.

interface ReportInterface

Fully qualified name: \TYPO3\CMS\Reports\ReportInterface

Interface for classes which provide a report.

getReport ( )

Returns the content for a report

returntype: string

getIdentifier ( )

Returns unique identifier of the report

returntype: string

getTitle ( )

Returns title of the report

returntype: string

getDescription ( )

Returns description of the report

returntype: string

getIconIdentifier ( )

Returns the identifier of the icon used for the report

returntype: string

StatusProviderInterface

Classes implementing this interface are registered automatically as status in the module Reports > Status if autoconfigure is enabled in Services.yaml or if it was registered manually by the tag reports.status.

If information from the current request is required for the status report implement \TYPO3\CMS\Reports\RequestAwareStatusProviderInterface.

If you need to provide extended information implement \TYPO3\CMS\Reports\ExtendedStatusProviderInterface.

Note

In PHP it is possible to implement several interfaces, so you can give detailed status reports that are request-aware:

EXT:my_extension/Classes/Status/MyStatus.php

class MyStatus implements RequestAwareStatusProviderInterface, ExtendedStatusProviderInterface
{
    // ...
}

interface StatusProviderInterface

Fully qualified name: \TYPO3\CMS\Reports\StatusProviderInterface

Interface for classes which provide a status report entry.

getStatus ( )

Returns the status of an extension or (sub)system

returntype: array

getLabel ( )

Return label of this status

returntype: string

ExtendedStatusProviderInterface

This interface extends \TYPO3\CMS\Reports\StatusProviderInterface. It can be used to provide detailed status reports.

interface ExtendedStatusProviderInterface

Fully qualified name: \TYPO3\CMS\Reports\ExtendedStatusProviderInterface

Interface for classes which provide a status report entry.

getDetailedStatus ( ): Returns the detailed status of an extension or (sub)system

RequestAwareReportInterface

This interface extends \TYPO3\CMS\Reports\ReportInterface. It can be used if information from the current request is required for the status message.

interface RequestAwareReportInterface

Fully qualified name: \TYPO3\CMS\Reports\RequestAwareReportInterface

Interface for classes which provide a report using information from the current request

getReport ( Psr\\Http\\Message\\ServerRequestInterface request = NULL)

Returns the content for a report

param Psr\\Http\\Message\\ServerRequestInterface $request: the request, default: NULL
returntype: string

getIdentifier ( )

Returns unique identifier of the report

returntype: string

getTitle ( )

Returns title of the report

returntype: string

getDescription ( )

Returns description of the report

returntype: string

getIconIdentifier ( )

Returns the identifier of the icon used for the report

returntype: string

RequestAwareStatusProviderInterface

This interface extends \TYPO3\CMS\Reports\StatusProviderInterface. It can be used if information from the current request is required for the status message.

interface RequestAwareStatusProviderInterface

Fully qualified name: \TYPO3\CMS\Reports\RequestAwareStatusProviderInterface

Interface for classes which provide a status report entry using information from the current request

getStatus ( Psr\\Http\\Message\\ServerRequestInterface request = NULL)

Returns the status of an extension or (sub)system

param Psr\\Http\\Message\\ServerRequestInterface $request: the request, default: NULL
returntype: array

getLabel ( )

Return label of this status

returntype: string

Custom reports registration

The only report provided by the TYPO3 core is the one called Status.

The status report itself is extendable and shows status messages like a system environment check and the status of the installed extensions.

Reports and status are automatically registered through the service configuration, based on the implemented interface.

Register a custom report

All reports have to implement the interface \TYPO3\CMS\Reports\ReportInterface. This, way, the report is automatically registered if autoconfigure is enabled in Services.yaml:

EXT:my_extension/Configuration/Services.yaml

services:
  _defaults:
    autoconfigure: true

Alternatively, one can manually tag a custom report with the reports.report tag:

EXT:my_extension/Configuration/Services.yaml

Vendor\MyExtension\Report\MyReport:
  tags:
    - name: reports.report

Register a custom status

All status providers must implement \TYPO3\CMS\Reports\StatusProviderInterface. If autoconfigure is enabled in Services.yaml, the status providers implementing this interface will be automatically registered.

Alternatively, one can manually tag a custom report with the reports.status tag:

Scheduler task

If the system extension scheduler is installed, you can create automatic reports with the help of a scheduler task.

To create a task for the reports functionality go to System > Scheduler, click on + (add Task) and chose System Status Update (reports) as Class.

Enter Notification Email Addresses where the reports should be sent and chose whether you want to be informed with each run.

The remaining settings are standard task settings provided by the scheduler extension.

Create a System Status Update task in System > Scheduler

System status notification mail

You will receive mails looking like this:

Example mail from the System status notification

This report contains all System Status Notifications from your TYPO3
installation. Please check the status report for more information.

Site: [DDEV] TYPO3

Issues:
[WARN] System environment check                 - 1 Test(s)
### Trusted hosts pattern is insecure: 1

TYPO3 Reports

Introduction

Installation

API Reference

Custom reports

Scheduler task

Introduction

What does it do?

Section "Security"

Installation

Installation with Composer

Installation without Composer

API

ReportInterface

StatusProviderInterface

ExtendedStatusProviderInterface

RequestAwareReportInterface

RequestAwareStatusProviderInterface

Custom reports registration

Register a custom report

Register a custom status

Scheduler task

System status notification mail

Sitemap