PHPackages                             mteu/typo3-monitoring - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Logging & Monitoring](/categories/logging)
4. /
5. mteu/typo3-monitoring

ActiveTypo3-cms-extension[Logging & Monitoring](/categories/logging)

mteu/typo3-monitoring
=====================

Exposes health status information of selected components in your TYPO3 instance to be integrated in external monitoring

0.4.3(2mo ago)5122↓100%2[4 PRs](https://github.com/mteu/typo3-monitoring/pulls)GPL-2.0-or-laterPHPPHP ~8.3.0 || ~8.4.0 || ~8.5.0CI passing

Since Jul 16Pushed 1mo agoCompare

[ Source](https://github.com/mteu/typo3-monitoring)[ Packagist](https://packagist.org/packages/mteu/typo3-monitoring)[ RSS](/packages/mteu-typo3-monitoring/feed)WikiDiscussions main Synced 1mo ago

READMEChangelog (10)Dependencies (19)Versions (19)Used By (0)

[![CGL](https://github.com/mteu/typo3-monitoring/actions/workflows/cgl.yaml/badge.svg)](https://github.com/mteu/typo3-monitoring/actions/workflows/cgl.yaml)[![Tests](https://github.com/mteu/typo3-monitoring/actions/workflows/tests.yaml/badge.svg?branch=main)](https://github.com/mteu/typo3-monitoring/actions/workflows/tests.yaml)[![Coverage](https://camo.githubusercontent.com/ec090cdf03722ac96b55b605bd4f9cfc43a7d8ba3bbeed2c76d64e5618326a0e/68747470733a2f2f636f766572616c6c732e696f2f7265706f732f6769746875622f6d7465752f7479706f332d6d6f6e69746f72696e672f62616467652e7376673f6272616e63683d6d61696e)](https://coveralls.io/github/mteu/typo3-monitoring?branch=main)[![Maintainability](https://camo.githubusercontent.com/7bd4d3f61730a8566d3f82c5764bf7a9732914d026a92cd9d7368f30bde8e082/68747470733a2f2f716c74792e73682f67682f6d7465752f70726f6a656374732f7479706f332d6d6f6e69746f72696e672f6d61696e7461696e6162696c6974792e737667)](https://qlty.sh/gh/mteu/projects/typo3-monitoring)

[![Extension Icon](Resources/Public/Icons/Extension.svg)](Resources/Public/Icons/Extension.svg)TYPO3 Monitoring
================

[](#typo3-monitoring)

[![TYPO3 versions](https://camo.githubusercontent.com/d9af94ae56da9a6f93ebf01c1c162d5b1bc482736b30a46ef35d4645e5385a70/68747470733a2f2f7479706f332d6261646765732e6465762f62616467652f6d6f6e69746f72696e672f7479706f332f736869656c64732e737667)](https://camo.githubusercontent.com/d9af94ae56da9a6f93ebf01c1c162d5b1bc482736b30a46ef35d4645e5385a70/68747470733a2f2f7479706f332d6261646765732e6465762f62616467652f6d6f6e69746f72696e672f7479706f332f736869656c64732e737667)[![Latest version](https://camo.githubusercontent.com/f125e8019f7aeac0b6281d2f920a0033c6e1de1ae3877d87a16dd041d5f6af47/68747470733a2f2f7479706f332d6261646765732e6465762f62616467652f6d6f6e69746f72696e672f76657273696f6e2f736869656c64732e737667)](https://camo.githubusercontent.com/f125e8019f7aeac0b6281d2f920a0033c6e1de1ae3877d87a16dd041d5f6af47/68747470733a2f2f7479706f332d6261646765732e6465762f62616467652f6d6f6e69746f72696e672f76657273696f6e2f736869656c64732e737667)[![Stability](https://camo.githubusercontent.com/fb32fdedd09a39ce2cf598af384114b4b67625cac75deea0bdb518ebd04159e4/68747470733a2f2f7479706f332d6261646765732e6465762f62616467652f6d6f6e69746f72696e672f73746162696c6974792f736869656c64732e737667)](https://camo.githubusercontent.com/fb32fdedd09a39ce2cf598af384114b4b67625cac75deea0bdb518ebd04159e4/68747470733a2f2f7479706f332d6261646765732e6465762f62616467652f6d6f6e69746f72696e672f73746162696c6974792f736869656c64732e737667)[![PHP Version Require](https://camo.githubusercontent.com/962fd05df1a49628387ba3cd7d34c4e3668e15239c1354fe951bf213c2f91afd/68747470733a2f2f706f7365722e707567782e6f72672f6d7465752f7479706f332d6d6f6e69746f72696e672f726571756972652f706870)](https://packagist.org/packages/mteu/typo3-monitoring)

This packages provides the TYPO3 CMS Extension `EXT:monitoring` which extends the CMS with a monitoring system that gives an insight into the health state of custom TYPO3 components through an API endpoint and a CLI command, e.g. for post-deployment checks.

Warning

This package is still in early development and must be considered unfit for production use. Bear with me. We'll get there.

🚀 Features
----------

[](#-features)

- [Extensible monitoring system](Documentation/Architecture.md) with automatic service discovery (using DI) for custom authorization and monitoring checks.
- Built-in **MiddlewareStatusProvider** for meta-level monitoring of the monitoring system itself
- Supports caching for expensive monitoring operations
- Delivers health reports in three ways:
    - **JSON response**: Returns structured responses for the overall health status
    - **CLI command**: Command-line interface for running monitoring checks
    - **Backend Module**: TYPO3 backend module

🔥 Quick Start
-------------

[](#-quick-start)

### Installation

[](#installation)

Install via Composer:

```
composer require mteu/typo3-monitoring
```

### Configuration

[](#configuration)

1. Configure the extension in the TYPO3 backend:

    - Go to **Admin Tools → Settings → Extension Configuration**
    - Select `monitoring`
    - Set the monitoring endpoint path (default: `/monitor/health`)
    - Configure authorizer settings for token-based and admin user authentication
2. Or better yet configure the settings programmatically:

    ```
    # config/system/settings.php