building5/apache-exporter

A library for exporting Apache status for Prometheus

apache-exporter-php

PHP port of apache_exporter. Slightly more convenient for PHP apps, since it does not require running the additional exporter process., _(*1)

Installation

$ composer require building5/apache-exporter

Usage

Be sure to have the Apache server-status page enabled and configured., _(*2)

Enable the status module using a2enmod status. It probably already has a status.conf configured in /etc/apache2/mods-enabled, but if not, you'll need that, too, _(*3)

<IfModule mod_status.c>
    <Location /server-status>
        SetHandler server-status
        Require local
    </Location>
    ExtendedStatus On

    <IfModule mod_proxy.c>
        # Show Proxy LoadBalancer status in mod_status
        ProxyStatus On
    </IfModule>
</IfModule>

You can test the status page by running curl http://localhost/server-status?auto on the web server to see if it's service the status page., _(*4)

Simple usage

In your PHP application, or in whatever webroot you choose, create a metrics.php script that calls ApacheExporter\Exporter::simple(). The use of .htaccess to restrict access, add passwords, etc. is left as an exercise., _(*5)

<?php
ApacheExporter\Exporter::simple();

Non-simple usage

If you have other stats you'd like to report, you can use the ApacheExporter\Exporter::export() method to export stats to the registry of your own choosing., _(*6)

The use of APC or Redis storage is not recommended. The counter fields like accesses, kilobytes and uptime will accumulate wildly if you do., _(*7)

See prometheus_client_php#68., _(*8)

<?php
use ApacheExporter\Exporter;
use Prometheus\CollectorRegistry;
use Prometheus\RenderTextFormat;
use Prometheus\Storage\InMemory;

$registry = new CollectorRegistry(new InMemory());
$renderer = new RenderTextFormat();

Exporter::export($registry);

// register other stats you want here

header('Content-type: ' . RenderTextFormat::MIME_TYPE);
echo $renderer->render($registry->getMetricFamilySamples());

License

apache-exporter-php is licensed under the MIT license., _(*9)