You can expose some of the application metrics using the prometheus service embedded to the Spiral application server.
Metrics service does not require configuration in the application. However, you must activate this service in .rr.yaml:
metrics:
# prometheus client address (path /metrics added automatically)
address: localhost:2112
You can view defaults metrics on http://localhost:2112/metrics
You can also publish application-specific metrics. First, you have to register a metric in your configuration file:
metrics:
address: localhost:2112
collect:
app_metric_counter:
type: counter
help: "Application counter."
Supported types: gauge, counter, summary, histogram.
To populate metric from application use Spiral\RoadRunner\MetricsInterface:
use Spiral\RoadRunner\MetricsInterface;
// ...
public function index(MetricsInterface $metrics)
{
$metrics->add('app_metric_counter', 1);
}
You can call MetricsInterface in middleware.
You can use tagged (labels) metrics to group values:
metrics:
address: localhost:2112
collect:
app_type_duration:
type: histogram
help: "Application counter."
labels: ["type"]
You should specify values for your labels while pushing the metric:
use Spiral\RoadRunner\MetricsInterface;
// ...
public function index(MetricsInterface $metrics)
{
$metrics->add('app_type_duration', 0.5, ['some-type']);
}