README

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

它是如何工作的？

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

安装

将作为Composer依赖项添加

composer require promphp/prometheus_client_php

用法

简单的计数器

\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']);

$summary = $registry->getOrRegisterSummary('test', 'some_summary', 'it observes a sliding window', ['type'], 84600, [0.01, 0.05, 0.5, 0.95, 0.99]);
$summary->observe(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
    ]
);

使用InMemory存储

$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());

使用APC或APCng存储

$registry = new CollectorRegistry(new APCng());
 or
$registry = new CollectorRegistry(new APC());

（有关更多详细信息，请参阅README.APCng.md文件）

高级用法

高级直方图用法

在实例化时传递一个空数组作为桶参数，将使用一组默认桶。虽然这对于典型的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.2 | ^8.0
• PHP Redis扩展
• 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=apcng vendor/bin/phpunit tests/Test/
docker-compose run phpunit env ADAPTER=redis vendor/bin/phpunit tests/Test/

性能测试

这目前测试了APC和APCng适配器，并报告APCng适配器是否对任何操作更慢。

phpunit vendor/bin/phpunit tests/Test/ --group Performance

测试也可以在容器内运行。

docker-compose up
docker-compose run phpunit vendor/bin/phpunit tests/Test/ --group Performance