一个用于发送指标的 PHP 包。

v1.1.4 2024-06-05 17:34 UTC

This package is not auto-updated.

Last update: 2024-09-23 10:30:09 UTC


README

简介

Watchlog 类是一个简单的 PHP 类,用于将各种类型的指标发送到服务器。它使用 Guzzle HTTP 客户端进行异步 HTTP 请求。

设置

  1. 安装 Watchlog: 确保您已经通过 Composer 安装了 Watchlog 包。在您的项目目录中运行以下命令

    composer require metrics-tracker/watchlog
  2. 包含 Watchlog 类: 确保您的 PHP 脚本包含了 Watchlog 类。使用自动加载器或直接包含类文件。

用法

以下是 Watchlog 类中可用的方法和如何使用它们

  1. 增加指标

    use MetricsTracker\Watchlog;
    
    $watchlog = new Watchlog();
    $watchlog->increment('page_views');
    // Optionally increment by a different value
    $watchlog->increment('page_views', 5);
  2. 减少指标

    $watchlog->decrement('active_users');
    // Optionally decrement by a different value
    $watchlog->decrement('active_users', 2);
  3. 设置仪表值

    $watchlog->gauge('memory_usage', 512);
  4. 设置百分比值

    $watchlog->percentage('cpu_usage', 75);
  5. 设置系统字节值

    $watchlog->systembyte('disk_space', 1024000);

注意

  • 确保服务器代理已设置以处理传入的指标请求。
  • 每个方法(incrementdecrementgaugepercentagesystembyte)都会使用指定的方法、指标名称和值将指标发送到服务器。
  • sendMetric 方法是一个内部私有方法,用于处理 HTTP 请求逻辑。

这份文档应该能帮助您了解如何为您的 PHP 应用程序设置和使用 Watchlog 类来跟踪指标。