building5/apache-exporter

A library for exporting Apache status for Prometheus

v1.0.0 2018-03-02 15:08 UTC

Requires

• php: >=7.1
• jimdo/prometheus_client_php: ^0.9.1

Requires (Dev)

• ext-apc: *
• phpunit/phpunit: ^6.5
• squizlabs/php_codesniffer: ^3.2

MIT

• David M. Lee, II

• apache
• prometheus

README

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

Installation

$ composer require building5/apache-exporter

Usage

Be sure to have the Apache server-status page enabled and configured.

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

<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.

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.

<?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.

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

See prometheus_client_php#68.

<?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.