Download the PHP package sportmateclub/pyr without Composer

Pyr

A prometheus exporter package for Lumen and Laravel.

Introduction

Prometheus is a time-series database with a UI and sophisticated querying language (PromQL) that can scrape metrics, counters, gauges and histograms over HTTP.

This package is a wrapper bridging beatlabs/prometheus_client_php (a fork of jimdo/prometheus_client_php) into Lumen and Laravel.

Example

Head to examples/lumen-app to check out our awesome example application. To get it you'll have to clone the Pyr repo, as the example is not included when downloaded from composer.

The example is a full project containing it's own README.md so you can check the library's functionality and the way it's intended to be used.

Installation

Add the repository to composer.json

Install the package via composer

After that you may enable facades and register the facade in your application's bootstrap/app.php

Then you should register the service provider in bootstrap/app.php

Please see below for instructions on how to enable metrics on Application routes, Guzzle calls and SQL queries.

Configuration

The package has a default configuration which uses the following environment variables.

To customize the configuration values you can either override the environment variables above (usually this is done in your application's .env file), or you can copy the included prometheus.php to config/prometheus.php, edit it and use it in your application as follows:

Metrics

The package allows you to observe metrics on:

• Application routes. Metrics on request method, request path and status code.
• Guzzle calls. Metrics on request method, URI and status code.
• SQL queries. Metrics on SQL query and query type.

In order to observe metrics in application routes (the time between a request and response), you should register the following middleware in your application's bootstrap/app.php:

The labels exported are

To observe Guzzle metrics, you should register the following provider in bootstrap/app.php:

The labels exported are

To observe SQL metrics, you should register the following provider in bootstrap/app.php:

The labels exported are

Note: you can disable logging the full query by turning off the configuration of PYR_COLLECT_FULL_SQL_QUERY.

Storage Adapters

The storage adapter is used to persist metrics across requests. The memory adapter is enabled by default, meaning data will only be persisted across the current request.

We recommend using the redis or apc adapter in production environments. Of course your installation has to provide a Redis or APC implementation.

The PYR_STORAGE_ADAPTER environment variable is used to specify the storage adapter.

If redis is used, the PYR_REDIS_HOST and PYR_REDIS_PORT vars also need to be configured. Optionally you can change the PYR_REDIS_TIMEOUT, PYR_REDIS_READ_TIMEOUT and PYR_REDIS_PERSISTENT_CONNECTIONS variables.

Exporting Metrics

The package adds a /metrics endpoint, enabled by default, which exposes all metrics gathered by collectors.

This can be turned on/off using the PYR_METRICS_ROUTE_ENABLED environment variable, and can also be changed using the PYR_METRICS_ROUTE_PATH environment variable.

Collectors

A collector is a class, implementing the CollectorInterface, which is responsible for collecting data for one or many metrics.

Please see the Example included below.

You can auto-load your collectors by adding them to the collectors array in the prometheus.php config.

Examples

Example usage

This is an example usage for a Lumen application

Collector

This is an example collector implementation:

php

• $exporter->registerCounter('search_requests_total', 'The total number of search requests.');