README

简介

Stats 是一个小的 PHP 项目，旨在帮助您从当前项目中使用统计信息。它支持任何您想要为其编写适配器的后端，并附带一个 statsd 适配器。

不需要实际安装，只需将其添加到您的 composer.json require 部分

	"heapstersoft/stats-writer": "1.0.x-dev"

首先，您需要像使用 composer 的任何项目一样包含您的 composer 自动加载

	require 'vendor/autoload.php';

理想情况下，您应该在中央位置只做一次。

然后，要将统计信息发送到后端（请参阅配置部分），您需要创建一个 stats 对象，将配置文件作为第一个参数传递，然后使用 increment 或 decrement

	$statWriter = new \Heapstersoft\Stats\Writer('config/stats.yml');

	$statWriter->increment('key1');

有关更多信息，我鼓励您查看源代码。

Stats 使用一个简单的 YAML 文件作为配置，其中包含一个必填的 "Adapter" 键。

在适配器下，只需提供适配器类。其余参数是适配器特定的。

有关示例配置，请参阅 StatsD 适配器部分。

StatsD 的示例配置文件

	Adapter:
	  class: \Heapstersoft\Stats\Adapter\StatsD
	  host: "127.0.0.1"
	  port: 8125
	  key: "#host#.test.#key#"

所有参数都应该不言自明，除了 "key" 参数。

键允许您自定义发送到 statsd 后端的键字符串。它支持任何包含一些特殊占位符的字符串。

目前这些占位符是：#host#，它被 $_SERVER['HTTP_HOST'] 变量替换，以及 #key#，它被传递给 increment 或 decrement 的值替换。

如果没有指定 #key#，它将被追加。