TYPO3 client for Prometheus

TYPO3 client for Prometheus 

Welcome to the manual of the extension t3_prometheus_client.

This guide provides an introduction to t3_prometheus_client. It shows the basic setup of a manual describing how to use the extension t3_prometheus_client.

Introduction 

Introduction to the extension t3-prometheus-client, general information.

Get an overview

Configuration 

How to configure the extension

Configuration reference

API 

Learn more about the API of the extension

API documentation
Extension key

t3_prometheus_client

Package name

maxfrerichs/t3-prometheus-client

Version

0.10.0

Language

en

Author

Max Frerichs

License

This document is published under the Creative Commons BY 4.0 license.

Rendered

Tue, 17 Feb 2026 08:51:36 +0000

Introduction 

t3_prometheus_client provides a client for Prometheus to access and process TYPO3-related application metrics. It allows system administrators and DevOps to collect runtime metrics from TYPO3 installations, enabling seamless integration with Prometheus and Grafana for monitoring and alerting. The client supports both scraping metrics from an endpoint and pushing metrics to a gateway, enabling a great variety of metrics to be monitored.

System requirements 

  • t3_prometheus_client 0.9+ requires TYPO3 12 or 13.
  • Prometheus (refer to https://prometheus.io for more information about Prometheus itself)
  • Optional: Pushgateway
  • Optional: Grafana for data visualization

Source code 

The source code is managed at

https://github.com/maxfrerichs/t3-prometheus-client

More pages 

Installation 

The extension can be installed as any other extension of TYPO3 CMS. Get the extension by one of the following methods:

  1. Use composer: Run

    composer require maxfrerichs/t3-prometheus-client
    Copied!

    in your TYPO3 installation.

  2. Get it from the Extension Manager: Switch to the module Admin Tools > Extensions. Switch to Get Extensions and search for the extension key t3_prometheus_client and import the extension from the repository.
  3. Get it from typo3.org: You can always get current version from TER by downloading the zip version. Upload the file afterwards in the Extension Manager.

and configure it.

Compatibility 

Ensure the compatibility of the extension with your TYPO3 installation by considering this compatibility matrix:

t3-prometheus-client TYPO3 PHP Support / Development
1.x 12 - 13 8.2 - 8.4 active support
0.x 12 - 13 8.2 - 8.4 active support

Versioning 

Server configuration 

[WIP]

Available metrics[WIP] 

The extension ships a default set of metrics that can be used to monitor TYPO3 installations. The following metrics are available by default:

  • Available Updates
  • Failed logins
  • ServiceUnavailableException counts
  • Failed Scheduler task runs

More metrics are planned to be added in the future.

Configuration 

The extension provides several configuration options that can be set in the Extension Configuration section of the TYPO3 Settings.

General Settings 

port

port
type

int

default

9090

label

Port for Prometheus

The port on which the Prometheus exporter will be accessible.

path

path
type

string

default

/metrics

label

URL path for Prometheus

The URL path where the Prometheus metrics will be exposed.

debug

debug
type

boolean

default

false

label

Debug mode

Enables debug mode. This may provide additional output useful for troubleshooting.

pushGateway

pushGateway
type

string

default

(empty)

label

Push-gateway location

Optional URL of a Prometheus Push gateway. If provided, metrics can be pushed instead of pulled.

Authentication 

mode

mode
type

options [none, basic, token]

default

token

label

Authentication mode

Select the authentication mode to protect the metrics endpoint:

  • none: No authentication
  • basic: Basic authentication (username and password)
  • token: Token-based authentication

token

token
type

string

default

(empty)

label

Authentication token

Used only when token-based authentication is selected. Specify the token clients must use to access metrics.

basicAuth.username

basicAuth.username
type

string

default

(empty)

label

User name

Username for basic authentication. Only relevant if authentication mode is set to basic.

basicAuth.password

basicAuth.password
type

string

default

(empty)

label

Password

Password for basic authentication. Only relevant if authentication mode is set to basic.

API 

This chapter describes the API of the extension. It includes information about how to extend the extension with custom metrics and how to use the events provided by the extension.

Events 

t3_prometheus_client provides a set of PSR-14 events that can be used to hook into the extension and modify its behavior. Current Events are:

  • BeforeMetricsRenderedEvent: Allows to modify the set of rendered metrics

[WIP]

Register custom metrics 

Classes that implement MFR\T3PromClient\Metrics\MetricsInterface are automatically tagged by the Dependency Injection container and added to the Metrics registry, allowing the registration of custom metrics by extension developers.

  1. Create a new PHP class that implements MFR\T3PromClient\Metrics\MetricsInterface
  2. Implement the contracts.
  3. Flush all TYPO3 caches.