Master | Develop |
---|---|
Open a command console, enter your project directory and execute:
$ composer require artprima/prometheus-metrics-bundle
Open a command console, enter your project directory and execute the following command to download the latest stable version of this bundle:
$ composer require artprima/prometheus-metrics-bundle
This command requires you to have Composer installed globally, as explained in the installation chapter of the Composer documentation.
Then, enable the bundle by adding it to the list of registered bundles
in the app/AppKernel.php
file of your project:
<?php
// app/AppKernel.php
// ...
class AppKernel extends Kernel
{
public function registerBundles()
{
$bundles = array(
// ...
new Artprima\PrometheusMetricsBundle\ArtprimaPrometheusMetricsBundle(),
);
// ...
}
// ...
}
config.yaml
artprima_prometheus_metrics:
# namespace is used to prefix the prometheus metrics
namespace: myapp
# metrics backend type
type: in_memory # possible values: in_memory, apcu, redis
# ignoring some routes in metrics
ignored_routes: [some_route_name, another_route_name]
# used in case of type = "redis"
redis:
host: 127.0.0.1
port: 6379
timeout: 0.1
read_timeout: 10
persistent_connections: false
password: ~
# used to disable default application metrics
disable_default_metrics: false
# used to enable console metrics
enable_console_metrics: false
routes.yaml
# expose /metrics/prometheus in your application
app_metrics:
resource: '@ArtprimaPrometheusMetricsBundle/Resources/config/routing.xml'
You can alternatively define your own path and rules:
app_metrics:
path: /mypath/mymetrics
controller: Artprima\PrometheusMetricsBundle\Controller\MetricsController::prometheus
Now your metrics are available to Prometheus using http://<yourapp_url>/metrics/prometheus.
If you want to collect your own metrics, you should create a class that will implement one or several interfaces that are
the children of the Artprima\PrometheusMetricsBundle\Metrics\MetricsCollectorInterface
.
<?php
declare(strict_types=1);
namespace App\Metrics;
use Artprima\PrometheusMetricsBundle\Metrics\RequestMetricsCollectorInterface;
use Artprima\PrometheusMetricsBundle\Metrics\TerminateMetricsCollectorInterface;
use Prometheus\CollectorRegistry;
use Symfony\Component\HttpKernel\Event\RequestEvent;
use Symfony\Component\HttpKernel\Event\TerminateEvent;
/**
* Class MyMetricsCollector.
*/
class MyMetricsCollector implements RequestMetricsCollectorInterface, TerminateMetricsCollectorInterface
{
/**
* @var string
*/
private $namespace;
/**
* @var CollectorRegistry
*/
private $collectionRegistry;
public function init(string $namespace, CollectorRegistry $collectionRegistry): void
{
$this->namespace = $namespace;
$this->collectionRegistry = $collectionRegistry;
}
private function incRequestsTotal(?string $method = null, ?string $route = null): void
{
$counter = $this->collectionRegistry->getOrRegisterCounter(
$this->namespace,
'http_requests_total',
'total request count',
['action']
);
$counter->inc(['all']);
if (null !== $method && null !== $route) {
$counter->inc([sprintf('%s-%s', $method, $route)]);
}
}
private function incResponsesTotal(?string $method = null, ?string $route = null): void
{
$counter = $this->collectionRegistry->getOrRegisterCounter(
$this->namespace,
'http_responses_total',
'total response count',
['action']
);
$counter->inc(['all']);
if (null !== $method && null !== $route) {
$counter->inc([sprintf('%s-%s', $method, $route)]);
}
}
// called on the `kernel.request` event
public function collectRequest(RequestEvent $event): void
{
$request = $event->getRequest();
$requestMethod = $request->getMethod();
$requestRoute = $request->attributes->get('_route');
// do not track "OPTIONS" requests
if ('OPTIONS' === $requestMethod) {
return;
}
$this->incRequestsTotal($requestMethod, $requestRoute);
}
// called on the `kernel.terminate` event
public function collectResponse(TerminateEvent $event): void
{
$response = $event->getResponse();
$request = $event->getRequest();
$requestMethod = $request->getMethod();
$requestRoute = $request->attributes->get('_route');
$this->incResponsesTotal($requestMethod, $requestRoute);
}
}
When using autoconfigure = true, by implementing Artprima\PrometheusMetricsBundle\Metrics\MetricsCollectorInterface
Symfony will automatically configure your metrics collector to be used by the collector registry.
Please note that Artprima\PrometheusMetricsBundle\Metrics\MetricsCollectorInterface
is a base interface since version 1.9.0,
which itself should not be implemented directly. Instead, your class should implement one or more child interfaces:
Artprima\PrometheusMetricsBundle\Metrics\PreRequestMetricsCollectorInterface
- collect metrics on "kernel.request" event with a priority of 1024.
Artprima\PrometheusMetricsBundle\Metrics\RequestMetricsCollectorInterface
- collect metrics on "kernel.request" event (default priority).
Artprima\PrometheusMetricsBundle\Metrics\PreExceptionMetricsCollectorInterface
- collect metrics on "kernel.exception" event with a priority of 1024.
Artprima\PrometheusMetricsBundle\Metrics\ExceptionMetricsCollectorInterface
- collect metrics on "kernel.exception" event with (default priority).
Artprima\PrometheusMetricsBundle\Metrics\TerminateMetricsCollectorInterface
- collect metrics on "kernel.terminate" event.
The following collectors will only work if you define enable_console_metrics: true
in the bundle configuration:
Artprima\PrometheusMetricsBundle\Metrics\ConsoleCommandMetricsCollectorInterface
- collect metrics on "console.command" event.
Artprima\PrometheusMetricsBundle\Metrics\ConsoleTerminateMetricsCollectorInterface
- collect metrics on "console.terminate" event.
Artprima\PrometheusMetricsBundle\Metrics\ConsoleErrorMetricsCollectorInterface
- collect metrics on "console.error" event.
The old behavior (where MetricsCollectorInterface
was a direct interface to implement), is still preserved, but will
be removed in future releases of the bundle.
If you don't use autoconfigure = true, then you will have to add this to your services.yaml
:
App\Metrics\MyMetricsCollector:
tags:
- { name: prometheus_metrics_bundle.metrics_generator }
These are default metrics exported by the application:
# TYPE php_info gauge
php_info{version="7.3.25-1+ubuntu18.04.1+deb.sury.org+1"} 1
# HELP symfony_http_2xx_responses_total total 2xx response count
# TYPE symfony_http_2xx_responses_total counter
symfony_http_2xx_responses_total{action="GET-app_dummy_homepage"} 1
symfony_http_2xx_responses_total{action="all"} 1
# HELP symfony_http_requests_total total request count
# TYPE symfony_http_requests_total counter
symfony_http_requests_total{action="GET-app_dummy_homepage"} 1
symfony_http_requests_total{action="all"} 1
# HELP symfony_instance_name app instance name
# TYPE symfony_instance_name gauge
symfony_instance_name{instance="dev"} 1
Note that, php_info comes from the underlying library promphp/prometheus_client_php
. Other metrics are gathered
by the built-in class Artprima\PrometheusMetricsBundle\Metrics
. Here, in the example we have a prefix symfony
and the metrics show a single request to the root named app_dummy_homepage
. Symfony instance is named dev
here.
Instance name comes from the server var HOSTNAME
($request->server->get('HOSTNAME')
) and defaults to dev
.
You are free to use the code in this repository under the terms of the MIT license. LICENSE contains a copy of this license.