synapse_redis_logger 0.1.0

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,22 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC
+.idea

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 Mason Jones
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,76 @@
+= redis_logger
+
+Application logging to redis.
+
+== Version
+
+Version 0.1.0
+
+== Installation
+
+  sudo gem install redis_logger
+
+You will also want to install the web interface for viewing the log entries:
+
+  http://github.com/masonoise/redis_logger-web
+
+
+== Using RedisLogger
+
+1. Install redis (http://code.google.com/p/redis/) and redis_logger
+
+2. In your application code, place a call to RedisLogger, using one of: debug, warn, error. Each call is expected to
+   pass a Hash of data, and an optional list of groups to which you want the log entry to belong. For example, you
+   might want to log all of your requests to a group called "requests", so you might put this call into your
+   application_controller.rb file in a before_filter:
+
+ RedisLogger.debug({ "request" => request.url,
+                        "remote_ip" => request.remote_ip,
+                        "user_id" => current_user.id,
+                        "username" => current_user.email
+ }, "requests")
+
+That would store the Hash containing four key/value pairs into the log entry, place it automatically in the
+"debug" group of entries, and also in the "requests" group of entries. Elsewhere in your code, you might log
+all user signup activity into a "signup" group, for example. Using the web interface, you can view the entries
+in a group or all the entries in an intersection of multiple groups -- for example, all errors in the signup
+process.
+
+If you want to use redis-cli to look things over instead of the web interface, here are the basics:
+
+  ./redis-cli
+  sort logger:set:debug limit 0 10 desc
+  ==> returns most recent 10 keys from the debug group, each of which maps to a Hash of log fields
+  hgetall log:1271274209
+  ==> returns the keys and values for that log entry
+  smembers logger:sets
+  ==> returns list of the groups that have been logged into
+
+== Known Issues
+
+1. Currently the log keys are simply the longint timestamps of each entry. If multiple threads are going
+   it's very possible that they'll log at the same instant and only one entry will survive. Need to work
+   out a way to identify each server with a unique id that could be added to the log keys, such as
+   log:1:<timestamp>, log:2:<timestamp>, etc.
+2. It would be nice to cache the group names so it doesn't have to add the group to logger:sets each time.
+3. Support for viewing intersection of groups is limited to most recent 100 entries right now. It will
+   be nice to keep the stored intersection set around for viewing, pagination, and export, but we need to
+   have a way to clean up the stored sets periodically.
+
+== Contributing
+
+This is very young and simple thus far. If you have some cool ideas, go for it, give it a try, if it seems
+good to you then get in touch and we'll see about merging it in.
+
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Author
+
+Mason Jones ~~~ stuff@charnel.com ~~~ @masonoise
+

data/Rakefile

@@ -0,0 +1,53 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "synapse_redis_logger"
+    gem.summary = %Q{Application logging into Redis}
+    gem.description = %Q{Provides support for applicationlogging to Redis, including grouping log entries and timestamping}
+    gem.email = "adams@synapse.com"
+    gem.homepage = "https://github.com/synapsepd/synapse_redis_logger"
+    gem.authors = ["masonoise", "saegey"]
+    gem.add_dependency('redis', '>= 1.0.4')
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/test_*.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+task :test => :check_dependencies
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "redis_logger #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/lib/redis_logger.rb

@@ -0,0 +1,141 @@
+require 'redis'
+
+#
+# redis_logger
+# http://github.com/masonoise/redis_logger
+#
+# Enable logging into redis database, with support for grouping log entries into one or more
+# groups.
+#
+# Log entries are stored in redis using keys of the form: log:<timestamp> with timestamp being
+# a longint representation of the time. Log entries are then also added to a set associated
+# with the log level, and then with any other sets specified in a list of "log groups".
+#
+# A set is maintained with the list of all of the groups: "logger:sets". Each group is
+# represented by a set called "logger:set:<name>" where name is the group name.
+#
+class RedisLogger
+
+  def self.redis=(server)
+    host, port, db = server.split(':')
+    @redis = Redis.new(:host => host, :port => port, :thread_safe => true, :db => db)
+  end
+
+  def self.redis
+    return @redis if @redis
+    self.redis = 'localhost:6379'
+    self.redis
+  end
+
+  #
+  # Provide standard methods for various log levels. Each just calls the private
+  # add_entry() method passing in its level name to use as the group name.
+  #
+  # For each, the log_entry is a Hash of items to include in the log, and sets is
+  # either a string or an array of strings, which are the groups into which the
+  # entry will be added (in addition to the standard log level group).
+  #
+
+  def self.debug(log_entry, sets = nil)
+    add_entry(log_entry, "debug", sets)
+  end
+
+
+  def self.warn(log_entry, sets = nil)
+    add_entry(log_entry, "warn", sets)
+  end
+
+  # Standard method for error messages. See comment above about debug()
+  def self.error(log_entry, sets = nil)
+    add_entry(log_entry, "error", sets)
+  end
+
+  #
+  # Utility methods, mainly used by the web interface to display the lists of
+  # groups and entries.
+  #
+
+  #
+  # Get the list of all of the log groups that exist.
+  #
+  def self.groups
+    group_keys = redis.smembers "logger:sets"
+    groups = {}
+    group_keys.each do |k|
+      groups[k] = redis.scard("logger:set:#{k}")
+    end
+    return groups
+  end
+
+  # How many entries are in the specified log group?
+  def self.size(group)
+    redis.scard("logger:set:#{group}")
+  end
+
+  #
+  # Get the entries from a log group, with optional start index and per_page count,
+  # which default to 0/50 if not specified. Entries are returned in reverse order,
+  # most recent to oldest.
+  #
+  def self.entries(group, start=0, per_page=50)
+    entry_list = redis.sort("logger:set:#{group}", { :limit => [ start, per_page ], :order => "DESC" })
+    fetch_entries(entry_list)
+  end
+
+  #
+  # Get the entries for an intersection of groups. Takes an array of group names and
+  # returns the top 100 resulting entries. This is done by intersecting into a new set,
+  # fetching the first 100 entries, then deleting the set.
+  # TODO: Save the intersected set, allow paginating, and use a cron to delete the temp sets
+  #
+  def self.intersect(groups)
+    counter = redis.incrby("logger:index", 1)
+    redis.sinterstore("logger:inter:#{counter}", groups.collect {|g| "logger:set:#{g}"})
+    entry_list = redis.sort("logger:inter:#{counter}", { :limit => [ 0, 100 ], :order => "DESC" })
+    entries = fetch_entries(entry_list)
+    redis.del("logger:inter:#{counter}")
+    return entries
+  end
+
+  #
+  # Utility method to fetch entries given an array returned from a group set.
+  #
+  def self.fetch_entries(entry_list)
+    entries = []
+    entry_list.each do |e|
+      entries << redis.hgetall("log:#{e}")
+    end
+    return entries
+  end
+
+
+  private
+
+  #
+  # Add the log entry. The level is passed in separately rather than being merged with the
+  # other sets just in case we want to treat it differently in the future.
+  #
+  def self.add_entry(log_entry, level, sets = nil)
+    # TODO: Need to add unique id to timestamp to prevent multiple servers from causing collisions
+    tstamp = Time.now.to_i
+    log_entry["timestamp"] = tstamp
+    log_entry.each { |key, value| redis.hset "log:#{tstamp}", key, value }
+    # hmset() seems to be broken so skip it for now. Could pipeline the above commands.
+    #redis.hmset tstamp, *(log_entry.to_a)
+
+    # Add entry to the proper log-level set, and desired group sets if any
+    case sets.class
+      when 'String'
+        sets = [sets]
+      when 'NilClass'
+        sets = []
+    end
+    # TODO: Shouldn't need to add the level every time; could do it once at startup?
+    redis.sadd "logger:sets", level
+    redis.sadd "logger:set:#{level}", tstamp
+    sets.each do |set|
+      redis.sadd "logger:sets", set
+      redis.sadd "logger:set:#{set}", tstamp
+    end
+  end
+end

data/redis_logger.gemspec

@@ -0,0 +1,54 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{synapse_redis_logger}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["masonoise", "saegey"]
+  s.date = %q{2010-04-16}
+  s.description = %q{Provides support for application logging to Redis, including grouping log entries and timestamping}
+  s.email = %q{adams@synapse.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "lib/redis_logger.rb",
+     "redis_logger.gemspec",
+     "test/helper.rb",
+     "test/test_redis_logger.rb"
+  ]
+  s.homepage = %q{https://github.com/synapsepd/synapse_redis_logger}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{Application logging into Redis}
+  s.test_files = [
+    "test/helper.rb",
+     "test/test_redis_logger.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<redis>, [">= 1.0.4"])
+    else
+      s.add_dependency(%q<redis>, [">= 1.0.4"])
+    end
+  else
+    s.add_dependency(%q<redis>, [">= 1.0.4"])
+  end
+end
+

data/test/helper.rb

@@ -0,0 +1,9 @@
+require 'rubygems'
+require 'test/unit'
+
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'redis_logger'
+
+class Test::Unit::TestCase
+end

data/test/test_redis_logger.rb

@@ -0,0 +1,7 @@
+require 'helper'
+
+class TestRedisLogger < Test::Unit::TestCase
+  def test_something_for_real
+    flunk "hey buddy, you should probably rename this file and start testing for real"
+  end
+end

metadata

@@ -0,0 +1,78 @@
+--- !ruby/object:Gem::Specification
+name: synapse_redis_logger
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- masonoise
+- saegey
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2010-04-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: redis
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.0.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.0.4
+description: Provides support for application logging to Redis, including grouping
+  log entries and timestamping
+email: adams@synapse.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE
+- README.rdoc
+files:
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/redis_logger.rb
+- redis_logger.gemspec
+- test/helper.rb
+- test/test_redis_logger.rb
+homepage: https://github.com/synapsepd/synapse_redis_logger
+licenses: []
+post_install_message: 
+rdoc_options:
+- --charset=UTF-8
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.19
+signing_key: 
+specification_version: 3
+summary: Application logging into Redis
+test_files:
+- test/helper.rb
+- test/test_redis_logger.rb
+has_rdoc: