PHP实现API监控_Prometheus采集指标数据【介绍】

浅丽姑娘_8985

浅丽姑娘_8985

2026-05-05

729人浏览

原创

php应用必须通过/metrics端点手动输出严格符合prometheus文本协议的指标:每行以# help、# type或指标名开头,标签值用双引号包裹并转义,响应头为text/plain; version=0.0.4,禁止空格/html/json,避免库自动输出缺陷。

php实现api监控_prometheus采集指标数据【介绍】

PHP 应用本身不直接暴露 Prometheus 格式指标,必须通过独立的 metrics 端点(如 /metrics)返回文本格式数据,且需严格遵循 Prometheus 文本协议规范,否则 prometheus 服务端抓取会失败或解析出错。

如何让 PHP 输出合法的 Prometheus metrics 文本

关键不是“生成指标”,而是“按协议输出”。Prometheus 要求每行以 # HELP、# TYPE 或指标名开头,指标名后跟大括号标签、空格、数值、可选时间戳。PHP 不能依赖第三方库“自动处理一切”——很多轻量库(如 promphp/promphp)默认不加 # TYPE 行,或把标签顺序搞乱,导致 scrape_series_added 为 0。

推荐手动构造(更可控):

header('Content-Type: text/plain; version=0.0.4');
echo "# HELP php_api_up Whether the API is up (1) or down (0)\n";
echo "# TYPE php_api_up gauge\n";
echo "php_api_up{env=\"prod\",service=\"user-api\"} " . (is_api_healthy() ? '1' : '0') . "\n";
echo "# HELP php_api_response_time_seconds API response time in seconds\n";
echo "# TYPE php_api_response_time_seconds histogram\n";
echo "php_api_response_time_seconds_bucket{le=\"0.1\",env=\"prod\"} 124\n";
echo "php_api_response_time_seconds_bucket{le=\"0.2\",env=\"prod\"} 189\n";
echo "php_api_response_time_seconds_sum{env=\"prod\"} 28.45\n";
echo "php_api_response_time_seconds_count{env=\"prod\"} 189\n";
  • is_api_healthy() 应包含真实探活逻辑(如连 DB、查健康接口),不能只返回 true
  • 所有指标名、标签键必须是 ASCII 字符,标签值需用双引号包裹,内部双引号要转义为 \"
  • 避免在指标行末尾加空格或制表符,prometheus 抓取器对空白敏感

为什么用 curl 或 file_sd_configs 都无法替代真实端点

有人试图绕过 PHP 暴露端点,改用 curl 定时调用 API 再写入文件,再让 Prometheus 用 textfile_collector 读——这会导致指标延迟高、时间戳不准、且无法体现瞬时状态(如某次请求超时)。更重要的是:textfile_collector 只支持静态文件,不支持动态标签(如按 host 区分多实例)。

btpanel phpsite 宝塔面板PHP网站
btpanel phpsite 宝塔面板PHP网站

宝塔面板 PHP 网站管理:站点创建、删除、启停、PHP 版本切换、域名管理、SSL证书管理、伪静态管理、数据库管理

下载

正确做法是让每个 PHP 实例独立暴露 /metrics,Prometheus 通过服务发现(如 Consul、DNS SRV)或静态配置直连:

scrape_configs:
  - job_name: 'php-api'
    static_configs:
      - targets: ['10.0.1.10:8080', '10.0.1.11:8080']
        labels:
          env: prod
          service: user-api
  • PHP 进程需监听非 80 端口(如 8080),避免与 Web 服务器端口冲突
  • 若用 Nginx/Apache,必须显式允许 /metrics 路由透传,不能被重写或拦截
  • 不要在 /metrics 响应中加 HTML、JSON 或其他 Content-Type,text/plain 是硬性要求

prometheus_client_php 库的常见陷阱

这个常用库(promphp/promphp)看似开箱即用,但实际部署时高频出问题:

  • 默认注册的 Gauge 和 Counter 不带 # TYPE 行,需手动调用 $registry->addCollector($collector) 并确保 $collector 实现了 getHelp() 和 getType()
  • 标签值含中文、斜杠、空格时,库不会自动转义,直接输出会导致 Prometheus 解析失败(错误:"expected = after label name")
  • 它把所有指标塞进一个字符串缓存,高并发下可能因未加锁导致输出错乱(例如两行指标混在一起)
  • 不支持直出 OpenMetrics 格式(v1.0.0+),而新版 Prometheus 默认启用 OpenMetrics 解析,建议显式禁用:enable_open_metrics: false

最稳妥的方式,是只用它做指标收集,自己写一个极简的 /metrics 路由处理器,调用 $registry->render() 后再做一次格式校验(比如检查是否每行都以 # 或字母开头),而不是全盘信任库的输出。

大量免费API接口:立即使用
涵盖生活服务API、金融科技API、企业工商API、等相关的API接口服务。免费API接口可安全、合规地连接上下游,为数据API应用能力赋能!

相关文章

PHP速学教程(入门到精通)
PHP速学教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

相关标签:

php

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
php文件怎么打开
php文件怎么打开

打开php文件步骤:1、选择文本编辑器;2、在选择的文本编辑器中,创建一个新的文件,并将其保存为.php文件;3、在创建的PHP文件中,编写PHP代码;4、要在本地计算机上运行PHP文件,需要设置一个服务器环境;5、安装服务器环境后,需要将PHP文件放入服务器目录中;6、一旦将PHP文件放入服务器目录中,就可以通过浏览器来运行它。

2023.09.01

10444

6

php怎么取出数组的前几个元素
php怎么取出数组的前几个元素

取出php数组的前几个元素的方法有使用array_slice()函数、使用array_splice()函数、使用循环遍历、使用array_slice()函数和array_values()函数等。本专题为大家提供php数组相关的文章、下载、课程内容,供大家免费下载体验。

2023.10.11

6141

5

php反序列化失败怎么办
php反序列化失败怎么办

php反序列化失败的解决办法检查序列化数据。检查类定义、检查错误日志、更新PHP版本和应用安全措施等。本专题为大家提供php反序列化相关的文章、下载、课程内容,供大家免费下载体验。

2023.10.11

2115

5

php怎么连接mssql数据库
php怎么连接mssql数据库

连接方法:1、通过mssql_系列函数;2、通过sqlsrv_系列函数;3、通过odbc方式连接;4、通过PDO方式;5、通过COM方式连接。想了解php怎么连接mssql数据库的详细内容,可以访问下面的文章。

2023.10.23

3868

4

php连接mssql数据库的方法
php连接mssql数据库的方法

php连接mssql数据库的方法有使用PHP的MSSQL扩展、使用PDO等。想了解更多php连接mssql数据库相关内容,可以阅读本专题下面的文章。

2023.10.23

4574

6

html怎么上传
html怎么上传

html通过使用HTML表单、JavaScript和PHP上传。更多关于html的问题详细请看本专题下面的文章。php中文网欢迎大家前来学习。

2023.11.03

3591

9

PHP出现乱码怎么解决
PHP出现乱码怎么解决

PHP出现乱码可以通过修改PHP文件头部的字符编码设置、检查PHP文件的编码格式、检查数据库连接设置和检查HTML页面的字符编码设置来解决。更多关于php乱码的问题详情请看本专题下面的文章。php中文网欢迎大家前来学习。

2023.11.09

5117

8

php文件怎么在手机上打开
php文件怎么在手机上打开

php文件在手机上打开需要在手机上搭建一个能够运行php的服务器环境,并将php文件上传到服务器上。再在手机上的浏览器中输入服务器的IP地址或域名,加上php文件的路径,即可打开php文件并查看其内容。更多关于php相关问题,详情请看本专题下面的文章。php中文网欢迎大家前来学习。

2023.11.13

4002

8

sprintf函数用法详解
sprintf函数用法详解

sprintf函数的用法:1、格式化字符串;2、指定输出宽度和精度;3、返回值。更多关于sprintf函数用法详解的内容,大家可以阅读下面的文章。

2023.11.27

11982

4

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
墨刀帮助中心
墨刀帮助中心

共0课时 | 0人学习

MyEclipse学习中心
MyEclipse学习中心

共0课时 | 0人学习

Apache Subversion 官方手册
Apache Subversion 官方手册

共0课时 | 0人学习