Von

Von is an opinionated Redis stats tracker. It works with keys, you choose one, Von increments it. It has a few built in conveniences:

Requirements

Von uses Redis for storing counters so you'll need it get going. If you're on OS X you can use homebrew:

$ brew install redis

Auto Incrementing Parent Keys

Keys are namespaced and every parent key is incremented when you increment a child key, for example:

Von.increment('downloads')          # bumps the 'downloads' key 1 time
Von.increment('downloads:app123')   # bumps the 'downloads:app123' key 1 time AND the 'downloads' key 1 time

Tracking Time Periods

By default Von will only bump a "total" counter for the given key. This is great, but what makes Von really useful is that it can be configured to group certain keys by hour, day, week, month, and year. And you can set limits on how many of each you want to keep around. Here's how it works:

Configuring Time Periods

Von.configure do |config|
    # Keep daily stats for 30 days
    config.counter 'downloads', daily: 30

    # Keep monthly stats for 3 months and yearly stats for 2 years
    config.counter 'uploads', monthly: 3, yearly: 2
end

Tracking the Current Time Period

If just wanna track stats on the current minute/hour/day/week/etc, you can set that up pretty easily with Von:

Von.configure do |config|
    # Track downloads stats for the current hour
    config.counter 'downloads', current: :hour

    # Track page views for the current day and week
    config.counter 'page-views', current: [ :day, :week ]
end

Tracking "Bests"

Time periods are pretty cool, but sometimes you wanna know when you did your best. You can track these with Von as well:

Von.configure do |config|
    # Track the best day for downloads
    config.counter 'downloads', best: :day

    # Track the best hour and week for page views
    config.counter 'page-views', best: [ :hour, :week ]
end

Incrementing

Once you've configured the keys you don't have to do anything special, just increment the key, Von will handle this rest.

Von.increment('downloads')
Von.increment('uploads')
Von.increment('page-views')

Getting Stats

# get the total downloads (returns an Integer)
Von.count('downloads').total       #=> 4

# get the monthly counts (returns an Array of Hashes)
Von.count('uploads').per(:month)   #=> [ { timestamp: '2012-03', count: 3 }, { timestamp: '2013-04', count: 1 }, { timestamp: '2013-05', count: 0 }]

# get the download stats for the hour
Von.count('downloads').this(:hour)          #=> 10
# or
Von.count('downloads').current(:hour)       #=> 10

# get the page-views for today
Von.count('page-views').today               #=> 78
Von.count('page-views').current(:day)       #=> 78

# get the best day for downloads (returns a Hash)
Von.count('downloads').best(:day)  #=> { timestamp: '2012-03-01', count: 10 }

One nice thing to note, if you're counting a time period and there wasn't a value stored for the particular hour/day/week/etc, it'll be populated with a zero, this ensures that if you want 30 days of stats, you get 30 days of stats.

Configuration

There are a few things you might want to configure in Von, you can do this in the configure block where you would also set time periods and expirations.

Von.configure do |config|
    # set the Redis connection to an already existing connection
    config.redis = Redis.current
    # Initialize a new Redis connection given options
    config.redis = { host: 'localhost', port: 6379 }
    
    # rescue Redis connection errors
    # if the connection fails, no errors are raised by default
    config.raise_connection_errors = false

    # set the top level Redis key namespace
    config.namespace = 'von'

    # set the various formatting for time periods (defaults shown)
    config.yearly_format  = '%Y'
    config.monthly_format = '%Y-%m'
    config.weekly_format  = '%Y-%m-%d'
    config.daily_format   = '%Y-%m-%d'
    config.hourly_format  = '%Y-%m-%d %H:00'
end

Installation

Add this line to your application's Gemfile:

gem 'von'

And then execute:

$ bundle

Or install it yourself as:

$ gem install von

Contributing

Fork it
Create your feature branch (git checkout -b my-new-feature)
Commit your changes (git commit -am 'Add some feature')
Push to the branch (git push origin my-new-feature)
Create new Pull Request

trvsdnn/von

trvsdnn

Reviews

Repository Details

Von