mfd / typo3-prometheus
Exports Prometheus metrics for TYPO3 instances
Installs: 232
Dependents: 0
Suggesters: 0
Security: 0
Stars: 10
Watchers: 4
Forks: 2
Open Issues: 4
Type:typo3-cms-extension
Requires
- php: >=5.6, <8.0
- typo3/cms-core: >=7.6.23,<9.0
Replaces
- mfc/prometheus: 0.0.2
- prometheus: 0.0.2
This package is auto-updated.
Last update: 2025-09-24 11:55:58 UTC
README
This extension provides a Prometheus metrics endpoint for TYPO3 instances. It exposes various TYPO3-specific metrics that can be scraped by Prometheus to monitor the health and performance of your TYPO3 site.
Installation
-
Install the extension via composer:
composer require mfd/typo3-prometheus
-
Activate the extension in the Extension Manager or via command line:
vendor/bin/typo3 extension:activate prometheus
Usage
After installation, a metrics endpoint will be available at /metrics
. This endpoint will return Prometheus-compatible metrics in the OpenMetrics text format.
Available Metrics
The following metrics are currently exposed:
typo3_version_info
: Information about the TYPO3 version and application contexttypo3_memory_usage_bytes
: Current memory usage in bytestypo3_memory_peak_usage_bytes
: Peak memory usage in bytestypo3_pages_total
: Total number of pages in the systemtypo3_content_elements_total
: Total number of content elements
Configuration
No additional configuration is needed. The extension works out of the box.
Security Considerations
It's recommended to restrict access to the /metrics
endpoint in production environments, as it may expose sensitive information. You can use your web server's configuration to restrict access based on IP addresses or authentication.
License
This extension is licensed under the terms of the GNU General Public License version 3 or later.