README.md in tabs-1.0.0 vs README.md in tabs-1.0.1
- old
+ new
@@ -214,11 +214,11 @@
PATTERN = "%Y-%m-%d-%H-%M-%S"
def name
:seconds
end
-
+
def serialize(timestamp)
timestamp.strftime(PATTERN)
end
def deserialize(str)
@@ -227,11 +227,11 @@
end
def from_seconds(s)
s / 1
end
-
+
def to_seconds
1
end
def add(timestamp, num_of_seconds)
@@ -335,15 +335,15 @@
You can use the expiration features to age out old metrics that may no longer be in your operational data set. For example, you may want to keep monthly or yearly data around but the minute or day level data isn't necessary past a certain date. You can set expirations for any resolution:
```ruby
Tabs.configure do |config|
- config.set_expirations(minute: 1.day, day: 1.week)
+ config.set_expirations(minute: 1.day, day: 1.week)
end
```
-The expiration date will start counting at the beginning at the end of the given resolution. Meaning that for a month resolution the given expiration time would start at the end of a given month. A month resolution metric recorded in January with an expiration of 2 weeks would expire after the 2nd week of February.
+The expiration date will start counting at the beginning of the end of the given resolution. Meaning that for a month resolution the given expiration time would start at the end of a given month. A month resolution metric recorded in January with an expiration of 2 weeks would expire after the 2nd week of February.
*NOTE: You cannot expire task metrics at this time, only counter and
values.*
### Configuration
@@ -356,11 +356,11 @@
# set it to an existing connection
config.redis = Redis.current
# pass a config hash that will be passed to Redis.new
config.redis = { :host => 'localhost', :port => 6379 }
-
+
# pass a prefix that will be used in addition to the "tabs" prefix with Redis keys
# Example: "tabs:my_app:metric_name"
config.prefix = "my_app"
# override default decimal precision (5)
@@ -370,11 +370,11 @@
# registers a custom resolution
config.register_resolution :second, SecondResolution
# unregisters any resolution
config.unregister_resolutions(:minute, :hour)
-
+
# sets TTL for redis keys of specific resolutions
config.set_expirations({ minute: 1.hour, hour: 1.day })
end
```
@@ -429,11 +429,11 @@
### v1.0.0
_WARNING: Version 1.0.0 is not compatible with previous versions of
Tabs_
-We have made a number of changes related to hour metric keys are stored
-in Redis. At this point we'll be following semantec versioning and will
+We have made a number of changes related to how our metric keys are stored
+in Redis. At this point we'll be following semantic versioning and will
support backwards compatability between major versions. In this release
we've added a number of major features:
* Metric expiration
* Key prefixes