Prometheus_client_php 项目启动与配置教程

1. 项目的目录结构及介绍

prometheus_client_php 项目主要包含以下目录和文件结构：

prometheus_client_php/
├── examples/             # 示例代码目录
│   ├── basic_example.php # 基础示例
│   └── advanced_example.php # 高级示例
├── lib/                  # PHP 库文件目录
│   ├── Collector.php      # Prometheus 数据收集器类
│   ├── Counter.php        # 计数器指标类
│   ├── Gauge.php          # 仪表指标类
│   ├── Histogram.php      # 直方图指标类
│   └── Summary.php        # 汇总指标类
├── php_client/           # PHP 客户端库
│   ├── collectors/       # 收集器相关类文件
│   ├── examples/         # 客户端使用示例
│   ├── exports/          # 导出器相关类文件
│   └── Prometheus.php     # Prometheus 客户端类
├── tests/                # 测试代码目录
├── README.md             # 项目说明文件
└── composer.json         # Composer 配置文件

• examples/：包含了一些使用该客户端库的基本和高级示例代码。
• lib/：存放了实现 Prometheus 客户端功能的核心 PHP 类文件。
• php_client/：是 PHP 客户端库的主要目录，包含了客户端的核心实现和示例。
• tests/：包含了一些单元测试代码，用于确保代码的质量和稳定性。
• README.md：项目的说明文档，通常包含了项目的描述、安装步骤和使用指南。
• composer.json：Composer 的配置文件，用于定义项目的依赖。

2. 项目的启动文件介绍

项目的启动文件主要是 examples/basic_example.php 和 examples/advanced_example.php。

• basic_example.php：这是一个简单的示例文件，用于展示如何使用 Prometheus 客户端进行基础指标收集和暴露 HTTP 端点。

  <?php
  // 引入自动加载文件
  require_once 'vendor/autoload.php';
  
  use PhpPrometheus\Client\Collector;
  use PhpPrometheus\Client\Counter;
  
  // 创建一个计数器指标
  $requests = new Counter('requests', 'The number of requests.');
  
  // 在请求处理开始时增加计数
  $requests->inc();
  

• advanced_example.php：这个文件包含了更多高级特性的示例，例如直方图、汇总等。

  <?php
  // 引入自动加载文件
  require_once 'vendor/autoload.php';
  
  use PhpPrometheus\Client\Collector;
  use PhpPrometheus\Client\Histogram;
  
  // 创建一个直方图指标
  $latency = new Histogram('request_latency', 'The latency of requests.', ['method'], 0.005, 0.01, 0.05, 0.1, 0.2, 0.5, 1, 2.5, 5, 10);
  
  // 记录请求处理时间
  $latency->observe(microtime(true) - $_SERVER['REQUEST_TIME_FLOAT']);
  

3. 项目的配置文件介绍

项目的配置文件主要是 composer.json，这个文件用于定义 PHP 项目的依赖。

{
    "name": "endclothing/prometheus_client_php",
    "description": "A PHP client for Prometheus.",
    "type": "library",
    "require": {
        "php": "^7.1|^8.0",
        "php-fig/cache": "^1.0",
        "guzzlehttp/guzzle": "^6.0|^7.0"
    },
    "autoload": {
        "psr-4": {"PhpPrometheus\\Client\\": "lib/", "PhpPrometheus\\Client\\Examples\\": "php_client/examples/"}
    }
}

在这个配置文件中，我们定义了项目依赖的 PHP 版本、其他库（如 GuzzleHttp），以及自动加载的命名空间和目录映射。

要启动和运行项目，首先需要确保安装了 Composer，然后通过以下命令安装依赖：

composer install

之后，可以通过 PHP 内置的服务器启动项目，并访问 examples/basic_example.php 或 examples/advanced_example.php 来查看效果。

php -S localhost:8000 -t public

访问 http://localhost:8000/basic_example.php 或 http://localhost:8000/advanced_example.php 即可看到 Prometheus 客户端的运行效果。