php使用prometheus

Tue, 13 Dec 2022 00:00:00 +0000

使用场景

长期趋势分析：通过对监控样本数据的持续收集和统计，对监控指标进行长期趋势分析。例如，通过对磁盘空间增长率的判断，我们可以提前预测在未来什么时间节点上需要对资源进行扩容。
对照分析：两个版本的系统运行资源使用情况的差异如何？在不同容量情况下系统的并发和负载变化如何？通过监控能够方便的对系统进行跟踪和比较。
告警：当系统出现或者即将出现故障时，监控系统需要迅速反应并通知管理员，从而能够对问题进行快速的处理或者提前预防问题的发生，避免出现对业务的影响。
故障分析与定位：当问题发生后，需要对问题进行调查和处理。通过对不同监控监控以及历史数据的分析，能够找到并解决根源问题。
数据可视化：通过可视化仪表盘能够直接获取系统的运行状态、资源使用情况、以及服务运行状态等直观的信息。

如何使用

引入软件包

composer require promphp/prometheus_client_php

封装公共类

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45


use Prometheus\CollectorRegistry;
use Prometheus\Storage\Redis;
use Prometheus\RenderTextFormat;

class Prometheus
{
 public static $registry;
 public static $renderer;
 public static $counter;

 public function __construct()
 {
 // 连接redis
 $adapter = new Redis();
 self::$registry = new CollectorRegistry($adapter);
 self::$renderer = new RenderTextFormat($adapter);
 }

 // 打点方法
 public function registerCounter($prometheus)
 {
 if (!empty($prometheus['action'])) {
 $namespace = $prometheus['namespace'];
 $name = $prometheus['name'];
 // it increases对应promethus counter数据类型
 self::$counter = self::$registry->registerCounter($namespace, $name, 'it increases', ['type']);
 if (is_array($prometheus['action'])) {
 foreach ($prometheus['action'] as $v) {
 // 将统计结果增加1
 self::$counter->incBy(1, [$v]); 
 }
 } else {
 // 将统计结果增加1
 self::$counter->incBy(1, [$prometheus['action']]); 
 }
 }
 }

 // 输出结果给prometheus服务
 public function RenderTextFormat(){
 $result = self::$renderer->render(self::$registry->getMetricFamilySamples());
 header('Content-type: ' . RenderTextFormat::MIME_TYPE);
 return $result;
 }
}

示例

下面代码表示给登录成功次数进行打点记录

1
2
3
4
5
6
7


$prometheus = new Prometheus();
$pthParam = [
 'action' => 'loginSuccess', // 要打点的数据
 'namespace' => 'service', // 命名空间
 'name' => 'loginApi', // 名称
];
$prometheus->registerCounter($pthParam);

扩展阅读

php注册consul

Tue, 30 Aug 2022 00:00:00 +0000

了解Consul

Consul 是一种服务网格解决方案，提供具有服务发现、配置和分段功能的全功能控制平面。这些功能中的每一个都可以根据需要单独使用，也可以一起使用以构建完整的服务网格。

如何注册

文档：https://www.consul.io/api-docs/agent/service

引入软件包

Composer

PHP的软件包管理系统，它提供用于管理PHP软件和依赖库关系的标准格式。

搜索软件包

composer软件包地址：https://packagist.org/

根据PHP版本引入扩展包

我的php版本是7.2，所以我选择了v4.2.1版本。 composer require sensiolabs/consul-php-sdk:v4.2.1

注册Consul

php注册代码

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35


public function actionConsulRegister()
{
 // 只注册一台到consul
 $redisKey = "SERVICE:CONSULREGISTER";
 $predis = \Yii::$app->predis;
 $result = $predis->client->get($redisKey);
 if ($result) {
 echo "no";
 exit;
 }
 $result = $predis->client->set($redisKey, 1);
 $expireTime = 60;
 $predis->client->expire($redisKey, $expireTime);

 putenv("CONSUL_HTTP_ADDR=CONSUL_URL");
 $kv = new \SensioLabs\Consul\Services\Agent();
 $port = "80";
 $ip = getHostByName(getHostName());
 $array = [
 'id' => "{$ip}:{$port}",
 'name' => 'prometheus',
 'tags' => ['prometheus_v1'],
 'address' => $ip,
 'port' => (int)$port,
 'enabletagoverride' => false,
 'check' => array(
 // 'deregistercriticalserviceafter' => '90m',
 'http' => "http://{$ip}:{$port}/metrics",
 'interval' => "15s",
 )
 ];
 $kv->registerService($array);
 echo "success";
 exit;
}

代码释义

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11


// 只注册一台到consul
$redisKey = "HTL:HOTELDETAIL:CONSULREGISTER";
$predis = \Yii::$app->predis;
$result = $predis->client->get($redisKey);
if ($result) {
 echo "no";
 exit;
}
$result = $predis->client->set($redisKey, 1);
$expireTime = 60;
$predis->client->expire($redisKey, $expireTime);

为什么要有redis锁

因php不能像java一样自请求，是通过容器增加启动钩子访问容器内的php服务注册consul，由于php的promethues数据是存在redis中，如果注册两台会造成prometheus获取的打点数据double。

consul注册参数

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28


// consul地址
putenv("CONSUL_HTTP_ADDR=CONSUL_URL");
$kv = new \SensioLabs\Consul\Services\Agent();
$port = "80";
// 获取本机ip
$ip = getHostByName(getHostName());
$array = [
 // 服务id
 'id' => "{$ip}:{$port}",
 // 服务名称
 'name' => 'prometheus',
 // 服务tag，数组，自定义，可以根据这个tag来区分同一个服务名的服务
 'tags' => ['prometheus_v1'],
 // 服务注册到consul的IP，服务发现，发现的就是这个IP
 'address' => $ip,
 // 服务IP对应端口号
 'port' => (int)$port,
 'enabletagoverride' => false,
 'check' => array(
 // 如果服务启动失败，多少时间内注销consul上的该服务。单位：minute
 // 'deregistercriticalserviceafter' => '90m',
 // 指定健康检查的URL，调用后只要返回20X，consul都认为是健康的
 'http' => "http://{$ip}:{$port}/metrics",
 // 健康检查间隔时间
 'interval' => "15s",
 )
];
$kv->registerService($array);

deregisterCriticalServiceAfter： 由于consul是安装在虚拟机上无法访问容器服务，所以不设置该参数，避免自动注销注册。

PHP on 雨夜无声

php使用prometheus

使用场景

如何使用

引入软件包

封装公共类

示例

扩展阅读

php注册consul

了解Consul

如何注册

引入软件包

Composer

搜索软件包

根据PHP版本引入扩展包

注册Consul

php注册代码

代码释义

为什么要有redis锁

consul注册参数

注册结果