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

使用内存存储

$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