
想象一下,你正在维护一个高性能的PHP微服务,或者一个处理大量数据的批处理脚本。为了确保服务的稳定性和性能,你需要实时监控它的各项指标:每秒请求数、数据库查询耗时、缓存命中率、错误发生次数等等。Prometheus是你的首选监控系统,因为它功能强大且生态成熟。
然而,当你着手将PHP应用的指标暴露给Prometheus时,你可能会遇到一些实际的困难:
# HELP、# TYPE以及指标名称、标签和值。手动拼接这些字符串,尤其是当指标类型多样(Gauge、Counter、Summary)且带有复杂标签时,极易出错且代码臃肿。面对这些挑战,我们迫切需要一个标准、高效且易于使用的解决方案。幸运的是,Composer生态圈总能给我们带来惊喜——previousnext/php-prometheus正是为此而生。
previousnext/php-prometheus:Prometheus指标序列化的利器previousnext/php-prometheus是一个专门用于将PHP数据序列化为Prometheus文本格式的库。它的核心理念是无状态,即它不负责管理指标的增减或聚合,它仅仅是一个“格式化工具”。你提供当前的指标值和标签,它负责按照Prometheus的规范,生成正确的输出。这种设计让它轻量、灵活,可以轻松集成到任何PHP应用中。
立即学习“PHP免费学习笔记(深入)”;
安装过程
使用Composer安装previousnext/php-prometheus非常简单:
<code class="bash">composer require previousnext/php-prometheus</code>
核心用法与示例
previousnext/php-prometheus支持Prometheus常见的几种指标类型:Gauge(瞬时值)、Counter(累加值)和Summary(统计摘要)。下面我们通过具体示例来看看它是如何工作的。
首先,你需要创建一个序列化器实例:
<pre class="brush:php;toolbar:false;">use PreviousNext\Prometheus\MetricSerializerFactory; $serializer = MetricSerializerFactory::create();
1. Gauge (瞬时值)
Gauge代表一个可以任意上下波动的瞬时值,比如当前内存使用量、当前在线用户数。
<pre class="brush:php;toolbar:false;">use PreviousNext\Prometheus\Gauge;
// 创建一个Gauge指标,指定名称、类型和帮助文本
$gauge = new Gauge("my_app", "memory_usage", "Current memory usage of the application in bytes");
// 设置指标值,可以带标签
$gauge->set(1024 * 1024 * 50, ['unit' => 'bytes', 'process' => 'web']); // 50MB
$gauge->set(1024 * 1024 * 45, ['unit' => 'bytes', 'process' => 'cli']); // 45MB
$gauge->set(0); // 也可以不带标签,表示默认实例
// 序列化为Prometheus文本格式
$output = $serializer->serialize($gauge, 'prometheus');
echo $output;预期输出:
<pre class="brush:php;toolbar:false;"># HELP my_app_memory_usage Current memory usage of the application in bytes
# TYPE my_app_memory_usage gauge
my_app_memory_usage{unit="bytes",process="web"} 52428800
my_app_memory_usage{unit="bytes",process="cli"} 47185920
my_app_memory_usage 02. Counter (累加值)
Counter代表一个单调递增的累加值,例如总请求数、总错误数。它只能增加或在重置时归零。
<pre class="brush:php;toolbar:false;">use PreviousNext\Prometheus\Counter;
// 创建一个Counter指标
$counter = new Counter("my_app", "total_requests", "Total number of requests processed");
// 设置当前累加值,同样可以带标签
$counter->set(12345, ['endpoint' => '/api/v1/users']);
$counter->set(678, ['endpoint' => '/api/v1/health']);
$output = $serializer->serialize($counter, 'prometheus');
echo $output;预期输出:
<pre class="brush:php;toolbar:false;"># HELP my_app_total_requests Total number of requests processed
# TYPE my_app_total_requests counter
my_app_total_requests{endpoint="/api/v1/users"} 12345
my_app_total_requests{endpoint="/api/v1/health"} 6783. Summary (统计摘要)
Summary用于表示一段时间内的采样点分布,例如请求延迟的P99、P95分位数,以及总和与总计数。
<pre class="brush:php;toolbar:false;">use PreviousNext\Prometheus\Summary;
// 创建一个Summary指标,注意这里的'request_duration'是标签的键名
$summary = new Summary("my_app", "request_latency", "Request latency in seconds", 'quantile');
// 设置分位数桶及其对应的值
$buckets = [0, 0.25, 0.5, 0.75, 1]; // 0s, 0.25s, 0.5s, 0.75s, 1s
$values = [2, 4, 6, 8, 10]; // 对应分位数的值
$summary->setValues($buckets, $values);
// 设置总和与总计数
$summary->setSum(543.21); // 总延迟时间
$summary->setCount(212); // 总请求次数
$output = $serializer->serialize($summary, 'prometheus');
echo $output;预期输出:
<pre class="brush:php;toolbar:false;"># HELP my_app_request_latency Request latency in seconds
# TYPE my_app_request_latency summary
my_app_request_latency{quantile="0"} 2
my_app_request_latency{quantile="0.25"} 4
my_app_request_latency{quantile="0.5"} 6
my_app_request_latency{quantile="0.75"} 8
my_app_request_latency{quantile="1"} 10
my_app_request_latency_sum 543.21
my_app_request_latency_count 212使用previousnext/php-prometheus库,你的PHP应用在与Prometheus集成时将获得以下显著优势:
在实际应用中,你可以将这些序列化后的指标输出到一个特定的HTTP接口(例如/metrics),然后配置Prometheus来抓取这个接口。这样,你的PHP应用就能无缝地融入到整个监控体系中,为你提供宝贵的运行时洞察。
previousnext/php-prometheus库为PHP开发者提供了一个优雅、高效的解决方案,用于将应用内部指标暴露给Prometheus监控系统。它将繁琐的格式化工作抽象化,让开发者能够专注于业务逻辑和指标本身,而不是底层的格式细节。如果你正在寻找一种简单可靠的方式来提升PHP应用的监控能力,那么这个库绝对值得你尝试。让你的PHP应用在Prometheus的照耀下,运行得更加透明、稳定!
以上就是如何将PHP应用数据高效地暴露给Prometheus监控系统,使用previousnext/php-prometheus可以轻松实现的详细内容,更多请关注php中文网其它相关文章!
PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!
Copyright 2014-2025 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号