openclerk/metrics

此包的最新版本(0.1.0)没有可用的许可证信息。

0.1.0 2017-09-11 07:39 UTC

This package is auto-updated.

Last update: 2024-09-14 09:12:29 UTC


README

一个用于PHP中简单指标(页面、数据库)捕获的库。

安装

在项目composer.json中将openclerk/metrics作为依赖项,然后运行composer update将其安装到项目中

{
  "require": {
    "openclerk/metrics": "dev-master"
  }
}

确保运行通过component-discovery可以发现的全部迁移;有关更多信息,请参阅openclerk/db的文档。

$migrations = new AllMigrations(db());
if ($migrations->hasPending(db())) {
  $migrations->install(db(), $logger);
}

功能

  1. 通过openclerk/db捕获页面和数据库的运行时指标
  2. 通过openclerk/pages捕获模板的运行时指标
  3. 可选地存储运行时指标到数据库中(需要通过component-discovery进行迁移)
  4. 可选地生成性能报告(需要openclerk/jobs)

使用

此项目使用openclerk/db进行数据库管理,openclerk/events捕获和处理事件,以及openclerk/config进行配置管理。

如有必要,配置组件

Openclerk\Config::merge(array(
  // these are default values
  "metrics_enabled" => true,
  "metrics_db_enabled" => true,
  "metrics_page_enabled" => true,
  "metrics_templates_enabled" => true,

  // store reports into the database
  "metrics_store" => false,
));

您现在需要注册指标事件处理器,并在必要时触发页面事件

// set up metrics
Openclerk\MetricsHandler::init(db());

// trigger page load metrics
Openclerk\Events::trigger('page_init', null);

// when rendering a page...
Openclerk\Events::trigger('page_start', null);
// do things
Openclerk\Events::trigger('page_end', null);

// print out metrics stats
print_r(Openclerk\MetricsHandler::getInstance()->printResults());

待办事项

  1. 测试
  2. CURL报告作业
  3. 如何扩展您的指标捕获(例如,图形指标)