README.md in dalli-0.11.1 vs README.md in dalli-0.11.2
- old
+ new
@@ -5,11 +5,11 @@
The name is a variant of Salvador Dali for his famous painting [The Persistence of Memory](http://en.wikipedia.org/wiki/The_Persistence_of_Memory).
-Dalli's development is sponsored by [NorthScale](http://www.northscale.com/). Many thanks to them!
+Dalli's development is sponsored by [Membase](http://www.membase.com/). Many thanks to them!
Design
------------
@@ -26,10 +26,11 @@
1. is approximately 20% faster than memcache-client (which itself was heavily optimized) in Ruby 1.9.2.
2. contains explicit "chokepoint" methods which handle all requests; these can be hooked into by monitoring tools (NewRelic, Rack::Bug, etc) to track memcached usage.
3. comes with hooks to replace memcache-client in Rails.
4. is approx 700 lines of Ruby. memcache-client is approx 1250 lines.
5. supports SASL for use in managed environments, e.g. Heroku.
+ 6. provides proper failover with recovery and adjustable timeouts
Installation and Usage
------------------------
@@ -109,10 +110,23 @@
Rails.cache.reset if forked
end
end
+Configuration
+------------------------
+Dalli accepts the following options. All times are in seconds and maybe fractional.
+
+**socket_timeout**: Timeout for all socket operations (connect, read, write). Default is 0.5.
+
+**socket_max_failures**: When a socket operation fails after socket_timeout, the same operation is retried. This is to not immediately mark a server down when there's a very slight network problem. Default is 2.
+
+**socket_failure_delay**: Before retrying a socket operation, the process sleeps for this amount of time. Default is 0.01.
+
+**down_retry_delay**: When a server has been marked down due to many failures, the server will be checked again for being alive only after this amount of time. Don't set this value to low, otherwise each request which tries the failed server might hang for the maximum timeout (see below). Default is 30 seconds.
+
+
Features and Changes
------------------------
Dalli is **NOT** 100% API compatible with memcache-client. If you have code which uses the MemCache API directly, it will likely need small tweaks. Method parameters and return values changed slightly. See Upgrade.md for more detail.
@@ -132,10 +146,10 @@
Eric Wong - for help using his [kgio](http://unicorn.bogomips.org/kgio/index.html) library.
Brian Mitchell - for his remix-stash project which was helpful when implementing and testing the binary protocol support.
-[NorthScale](http://northscale.com) - for their project sponsorship
+[Membase](http://membase.com) - for their project sponsorship
[Bootspring](http://bootspring.com) is my Ruby and Rails consulting company. We specialize in Ruby infrastructure, performance and scalability tuning for Rails applications. If you need help, please [contact us](mailto:info@bootspring.com) today.
Author