README

此库使用Redis或APCu来进行客户端聚合。如果使用Redis，我们建议在您的PHP工作进程旁边运行本地Redis实例。

它是如何工作的？

通常PHP工作进程不会共享任何状态。您可以选择三种适配器：Redis、APC或内存适配器。虽然第一种需要一个单独的二进制运行，但第二种只需要安装APC扩展。如果您不需要在请求之间持久化度量值（例如，一个长时间运行的cron作业或脚本），内存适配器可能适合使用。

安装

作为Composer依赖项添加

composer require pfinal/prometheus-php-client

用法

一个简单的计数器

\Prometheus\CollectorRegistry::getDefault()
    ->getOrRegisterCounter('', 'some_quick_counter', 'just a quick measurement')
    ->inc();

写入一些增强的度量值

$registry = \Prometheus\CollectorRegistry::getDefault();

$counter = $registry->getOrRegisterCounter('test', 'some_counter', 'it increases', ['type']);
$counter->incBy(3, ['blue']);

$gauge = $registry->getOrRegisterGauge('test', 'some_gauge', 'it sets', ['type']);
$gauge->set(2.5, ['blue']);

$histogram = $registry->getOrRegisterHistogram('test', 'some_histogram', 'it observes', ['type'], [0.1, 1, 2, 3.5, 4, 5, 6, 7, 8, 9]);
$histogram->observe(3.5, ['blue']);

手动注册和检索度量值（这些步骤在getOrRegister...方法中合并）

$registry = \Prometheus\CollectorRegistry::getDefault();

$counterA = $registry->registerCounter('test', 'some_counter', 'it increases', ['type']);
$counterA->incBy(3, ['blue']);

// once a metric is registered, it can be retrieved using e.g. getCounter:
$counterB = $registry->getCounter('test', 'some_counter')
$counterB->incBy(2, ['red']);

公开度量值

$registry = \Prometheus\CollectorRegistry::getDefault();

$renderer = new RenderTextFormat();
$result = $renderer->render($registry->getMetricFamilySamples());

header('Content-type: ' . RenderTextFormat::MIME_TYPE);
echo $result;

更改Redis选项（示例显示默认值）

\Prometheus\Storage\Redis::setDefaultOptions(
    [
        'host' => '127.0.0.1',
        'port' => 6379,
        'password' => null,
        'timeout' => 0.1, // in seconds
        'read_timeout' => '10', // in seconds
        'persistent_connections' => false
    ]
);

使用内存存储

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

$counter = $registry->registerCounter('test', 'some_counter', 'it increases', ['type']);
$counter->incBy(3, ['blue']);

$renderer = new RenderTextFormat();
$result = $renderer->render($registry->getMetricFamilySamples());

高级用法

高级直方图用法

在实例化时传递空数组作为桶参数，将使用一组默认桶。虽然这对于典型的Web应用程序是一个很好的基础，但有一个命名的构造函数来帮助生成指数/几何桶。

例如

Histogram::exponentialBuckets(0.05, 1.5, 10);

这将从0.05的值开始桶，每个桶增加1.5的倍数，跨越10个桶。

也请参阅示例。

PushGateway支持

从2.0.0版本开始，此库不再支持Prometheus PushGateway，因为我们希望将此包尽可能小型化。如果您需要Prometheus PushGateway支持，可以使用配套库：https://github.com/PromPHP/prometheus_push_gateway_php

composer require promphp/prometheus_push_gateway_php

开发

依赖项

• PHP ^7.0
• PHP APCu扩展
• Composer
• Redis

启动Redis实例

docker-compose up Redis

运行测试

composer install

# when Redis is not listening on localhost:
# export REDIS_HOST=192.168.59.100
./vendor/bin/phpunit

黑盒测试

仅使用docker-compose启动nginx、fpm和Redis设置

docker-compose up

选择您想要测试的适配器。

docker-compose run phpunit env ADAPTER=apc vendor/bin/phpunit tests/Test/
docker-compose run phpunit env ADAPTER=redis vendor/bin/phpunit tests/Test/