README.md in tabs-0.6.1 vs README.md in tabs-0.6.2
- old
+ new
@@ -1,16 +1,17 @@
![Travis Status](https://api.travis-ci.org/thegrubbsian/tabs.png)
# Tabs
-Tabs is a redis-backed metrics tracker that supports counts, sums, averages, and min/max stats sliceable by the minute, hour, day, week, month, and year.
+Tabs is a redis-backed metrics tracker that supports counts, sums,
+averages, and min/max, and task based stats sliceable by the minute, hour, day, week, month, and year.
## Installation
Add this line to your application's Gemfile:
- gem 'tabs'
+ gem 'tabs', '~> 0.6.1'
And then execute:
$ bundle
@@ -26,11 +27,11 @@
Please us 0.6.0 on new applications only. However, the 'Task' metric
type will only be available in v0.6.0 and above.
## Usage
-Metrics come in two flavors: counters and values.
+Metrics come in three flavors: counters, values, and tasks.
### Counter Metrics
A counter metric simply records the number of events that occur within a given timeframe. To create a counter metric called ‘website-visits’, simply call:
@@ -127,20 +128,20 @@
```
Retrieving stats for a task metric is just like the other types:
```ruby
-Tabs.get_stats("mobile-to-purchase", (Time.now - 6.hours)..Time.now), : minute)
+Tabs.get_stats("mobile-to-purchase", (Time.now - 6.hours)..Time.now), :minute)
```
This will return a hash like this:
```ruby
{
started: 3, #=> number of items started within the period
completed: 2, #=> number of items completed within the period
completed_within_period: 2, #=> number started AND completed within the period
- completion_rate: 0.18, #=> rate of completion
+ completion_rate: 0.18, #=> rate of completion in the specified resolution (e.g. :minute)
average_completion_time: 1.5 #=> average completion time in the specified resolution
}
```
### Resolutions