mondrian_redis_segment_cache 0.0.3-java → 0.0.4-java

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0b363ec2ebfcef465a41d81444cd42ab70c2029a
-  data.tar.gz: fda2bebc4d9ae5db22cd53449b060269f0450617
+  metadata.gz: 5037596f5c1489481ba34ee7cdbdfefa8a5ae1b9
+  data.tar.gz: f5c3b7fd0c3d5f900d71274266f8c921cc2aca7d
 SHA512:
-  metadata.gz: bd1974e2d202c94f60b3063d7a3556c884cc4dd52b45fd416cb47e6a8760a00110975723929df9603be739071cbc6421864b67d8224ec0059f1dde5bb5385db6
-  data.tar.gz: ecb56df3250164aa5c2c324107e20eb4149c20341f69f51a90a0b63ec1bfbfa860fca856c27b21c9241040e320ce1c43666f28bf0d90fc8020ea67baafe442e8
+  metadata.gz: 63618da9eb4cf34f3863e3d77611c518e9abb16bf6d912256ed924dd9a247287b900ed9acb2f92f606abefbcaece3c30c243c1faa50dac22d0151aaefd7b4ca5
+  data.tar.gz: 9267d27e4b9897c1f5bd657b626da7edaeb53b48120b5f5f3e9f8424c491b2aced2ada7e42c469f8fe78fc982cfc51831795e2bc73e770d6adf29a0cb849c09e

data/README.md

@@ -1,6 +1,21 @@
 # MondrianRedisSegmentCache
 
-TODO: Write a gem description
+Mondrian ships with an in memory segment cache that is great for standalone deployments of Mondrian, but doesn't
+scale out with multiple nodes.  An interface is provided for extending Mondrian with a shared Segment Cache and
+examples of other implementations are in the links below.
+
+In order to use Mondrian with Redis (our preferred caching layer) and Ruby (our preferred language -- Jruby) we had
+to implement the SegmentCache interface from Mondrian and use the Redis notifications api.
+
+Mondrian's segment cache needs to be able to get/set/remove cache items and also get any updates from the caching server
+as other nodes are getting/setting/removing entries.  This means that we need to use both the notifications and subscribe
+api's from Redis.
+
+http://stackoverflow.com/questions/17533594/implementing-a-mondrian-shared-segmentcache
+http://mondrian.pentaho.com/api/mondrian/spi/SegmentCache.html
+https://github.com/pentaho/mondrian/blob/master/src/main/mondrian/rolap/cache/MemorySegmentCache.java
+https://github.com/webdetails/cdc
+http://redis.io/topics/notifications
 
 ## Installation
 
@@ -18,7 +33,30 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+If using Rails you can put the configuration in an initializer
+
+```ruby
+require 'redis'
+require 'mondrian_redis_segment_cache'
+
+# Setup a Redis connection
+MONDRIAN_REDIS_CONNECTION = Redis.new(:url => "redis://localhost:1234/2")
+MONDRIAN_SEGMENT_CACHE = ::MondrianRedisSegmentCache::Cache.new(MONDRIAN_REDIS_CONNECTION)
+
+# Register the segment cache with the Mondrian Injector
+::Java::MondrianSpi::SegmentCache::SegmentCacheInjector::add_cache(MONDRIAN_SEGMENT_CACHE)
+```
+
+In Redis we use the notifications api, so you must turn it on!
+It is off by default because it is a new feature and can be CPU intensive. Redis does a ton, so there is a minimum of notifications
+that must be turned on for this gem to work.
+
+`notify-keyspace-events Eg$`
+
+This tells Redis to publish keyevent events (which means we can subscribe to things like set/del) and to publish the generic commands
+(like DEL, EXPIRE) and finally String commands (like SET)
+
+The SegmentCache uses these notifications to keep Mondrian in sync across your Mondrian instances.
 
 ## Contributing
 

data/lib/mondrian_redis_segment_cache/cache.rb

@@ -1,4 +1,6 @@
 require 'redis'
+require 'mondrian_redis_segment_cache/created_event'
+require 'mondrian_redis_segment_cache/deleted_event'
 
 module MondrianRedisSegmentCache
   class Cache
@@ -82,7 +84,7 @@ module MondrianRedisSegmentCache
 
       if segment_header
         listeners.each do |listener|
-          created_event = MondrianRedisCacheCreatedEvent.new(segment_header)
+          created_event = ::MondrianRedisSegmentCache::CreatedEvent.new(segment_header)
           listener.handle(created_event)
         end
       end
@@ -93,8 +95,8 @@ module MondrianRedisSegmentCache
 
       if segment_header
         listeners.each do |listener|
-          deleted_event = MondrianRedisCacheDeletedEvent.new(segment_header)
-          listener.handle(deleted_evet)
+          deleted_event = ::MondrianRedisSegmentCache::DeletedEvent.new(segment_header)
+          listener.handle(deleted_event)
         end
       end
     end

data/lib/mondrian_redis_segment_cache/version.rb

@@ -1,3 +1,3 @@
 module MondrianRedisSegmentCache
-  VERSION = "0.0.3"
+  VERSION = "0.0.4"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mondrian_redis_segment_cache
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: java
 authors:
 - Brandon Dewitt
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2014-06-20 00:00:00.000000000 Z
+date: 2014-06-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redis