nutcracker 0.4.0.16 → 0.4.1.18

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0131d3faa17fa5c4bae74bf0928e83b67526c88c
-  data.tar.gz: fff7fa05ce68995614938c5119c6e5e7ebdebf80
+  metadata.gz: 96ee5eec694e7984421bb7cc24f4cb081ffebea3
+  data.tar.gz: 357729667f8ea82d7c6b39f14ada570040f675c9
 SHA512:
-  metadata.gz: 30fd3866cdba768abd2671cf3de3f7e1942803879915c1e05f19a3dfe5d72ee355f7b42adec59439310038d36cba1d807a14149c06f69cefd300aed389df6c16
-  data.tar.gz: e6f4511267e566fa3c8ab105bc4523433bd367d3b55126698d9649094f5b5fac288450346db8f8b6a130f97604de62dee04de47e2bce6f8ecfa62910d0663723
+  metadata.gz: 22cd6aea9938befd72afb512e5b0d003795d29760618c39c7d76b1e433f3dcafec84a59063dd5d1b820cb36758ded7a335e514ea4202a072714bd6a7a168ae7c
+  data.tar.gz: a99b46cb63b4b447a5ba588317fc0bf7bc411a976ae7f72542b304b521a5b108bdb63f8f5a6fb4f644a6ff54cc47debbd847c70b37b12b0115323a69c3282253

data/Rakefile

@@ -10,12 +10,12 @@ sversion = Nutcracker.version.split(".")[0..2].join(".")
 
 desc "Download Nutcracker c app"
 task :download do
-  "twemproxy-#{sversion}.tar.gz".tap do |tarball|
+  "nutcracker-#{sversion}.tar.gz".tap do |tarball|
     sh "mkdir ext" unless File.directory? "ext"
     sh "rm -rf ext/nutcracker"
-    sh "wget https://github.com/twitter/twemproxy/archive/v#{sversion}.tar.gz -O #{tarball}"
+    #sh "wget https://github.com/twitter/twemproxy/archive/v#{sversion}.tar.gz -O #{tarball}"
     sh "tar -zxvf #{tarball}"
-    sh "mv twemproxy-#{sversion} ext/nutcracker"
+    sh "mv nutcracker-#{sversion} ext/nutcracker"
     Dir.chdir("ext/nutcracker") do 
       sh "autoreconf -fvi"
       c = File.read("configure").gsub("-${am__api_version}","")

data/ext/nutcracker/ChangeLog

@@ -1,3 +1,36 @@
+ 2015-22-06  Manju Rajashekhar  <manj@cs.stanford.edu>
+    * twemproxy: version 0.4.1 release
+      redis_auth is only valid for a redis pool
+      getaddrinfo returns non-zero +ve value on error
+      fix-hang-when-command-only (charsyam)
+      fix bug crash when get command without key and whitespace (charsyam)
+      mark server as failed on protocol level transiet failures like -OOM, -LOADING, etc
+      implemented support for parsing fine grained redis error response
+      remove redundant conditional judgement in rbtree deletion (leo ma)
+      fix bug mset has invalid pair (charsyam)
+      fix bug mset has invalid pair (charsyam)
+      temp fix a core on kqueue (idning)
+      support "touch" command for memcached (panmiaocai)
+      fix redis parse rsp bug (charsyam)
+      SORT command can take multiple arguments. So it should be part of redis_argn() and not redis_arg0()
+      remove incorrect assert because client could send data after sending a quit request which must be discarded
+      allow file permissions to be set for UNIX domain listening socket (ori liveneh)
+      return error if formatted is greater than mbuf size by using nc_vsnprintf() in msg_prepend_format()
+      fix req_make_reply on msg_get, mark it as response (idning)
+      redis database select upon connect (arne claus)
+      redis_auth (charsyam)
+      allow null key(empty key) (idning)
+      fix core on invalid mset like "mset a a a" (idning)
+
+2014-18-10  idning <idning@gmail.com>
+    * twemproxy: version 0.4.0 release
+      mget improve (idning)
+      many new commands supported: LEX, PFADD, PFMERGE, SORT, PING, QUIT, SCAN... (mattrobenolt, areina, idning)
+      handle max open file limit(allenlz)
+      add notice-log and use ms time in log(idning)
+      fix bug in string_compare (andyqzb)
+      fix deadlock in sighandler (idning)
+
 2013-20-12  Manju Rajashekhar  <manj@cs.stanford.edu>
     * twemproxy: version 0.3.0 release
       SRANDMEMBER support for the optional count argument (mkhq)
@@ -28,12 +61,10 @@
       add support for hash tags
 
 2012-18-10  Manju Rajashekhar  <manj@twitter.com>
-
     * twemproxy: version 0.2.2 release
       fix the off-by-one error when calculating redis key length
 
 2012-12-10  Manju Rajashekhar  <manj@twitter.com>
-
     * twemproxy: version 0.2.1 release
       don't use buf in conf_add_server
       allow an optional instance name for consistent hashing (charsyam)
@@ -41,7 +72,6 @@
       add stats-bind-any -a option (charsyam)
 
 2012-12-03  Manju Rajashekhar  <manj@twitter.com>
-
     * twemproxy: version 0.2.0 release
       add -D or --describe-stats command-line argument to print stats description
       redis support in twemproxy
@@ -54,7 +84,6 @@
       delete stats tracking memcache requests and responses; stats module no longer tracks protocol related stats
 
 2012-10-27  Manju Rajashekhar  <manj@twitter.com>
-
     * twemproxy: version 0.1.20 release
       on msg_repair, msg->pos should point to nbuf->pos and not nbuf->last
       refactor memcache parsing code into proto directory
@@ -63,23 +92,19 @@
       fix log_hexdump and loga_hexdump
 
 2012-07-31  Manju Rajashekhar  <manj@twitter.com>
-
     * twemproxy: version 0.1.19 release
       close server connection on a stray response (yashh, bmatheny)
 
 2012-06-19  Manju Rajashekhar  <manj@twitter.com>
-
     * twemproxy: version 0.1.18 release
       command line option to set mbuf chunk size
 
 2012-05-09  Manju Rajashekhar  <manj@twitter.com>
-
     * twemproxy: version 0.1.17 release
       use _exit(0) instead of exit(0) when daemonizing
       use loga instead of log_stderr in nc_stacktrace
 
 2012-02-09  Manju Rajashekhar  <manj@twitter.com>
-
     * twemproxy: version 0.1.16 release
       twemproxy (aka nutcracker) is a fast and lightweight proxy for memcached protocol.
 

data/ext/nutcracker/Makefile.in

@@ -1,7 +1,7 @@
-# Makefile.in generated by automake 1.14.1 from Makefile.am.
+# Makefile.in generated by automake 1.15 from Makefile.am.
 # @configure_input@
 
-# Copyright (C) 1994-2013 Free Software Foundation, Inc.
+# Copyright (C) 1994-2014 Free Software Foundation, Inc.
 
 # This Makefile.in is free software; the Free Software Foundation
 # gives unlimited permission to copy and/or distribute it,
@@ -14,7 +14,17 @@
 
 @SET_MAKE@
 VPATH = @srcdir@
-am__is_gnu_make = test -n '$(MAKEFILE_LIST)' && test -n '$(MAKELEVEL)'
+am__is_gnu_make = { \
+  if test -z '$(MAKELEVEL)'; then \
+    false; \
+  elif test -n '$(MAKE_HOST)'; then \
+    true; \
+  elif test -n '$(MAKE_VERSION)' && test -n '$(CURDIR)'; then \
+    true; \
+  else \
+    false; \
+  fi; \
+}
 am__make_running_with_option = \
   case $${target_option-} in \
       ?) ;; \
@@ -78,15 +88,6 @@ POST_UNINSTALL = :
 build_triplet = @build@
 host_triplet = @host@
 subdir = .
-DIST_COMMON = $(srcdir)/Makefile.in $(srcdir)/Makefile.am \
-	$(top_srcdir)/configure $(am__configure_deps) \
-	$(srcdir)/config.h.in $(dist_man_MANS) ChangeLog \
-	config/compile config/config.guess config/config.sub \
-	config/install-sh config/missing config/ltmain.sh \
-	$(top_srcdir)/config/compile $(top_srcdir)/config/config.guess \
-	$(top_srcdir)/config/config.sub \
-	$(top_srcdir)/config/install-sh $(top_srcdir)/config/ltmain.sh \
-	$(top_srcdir)/config/missing
 ACLOCAL_M4 = $(top_srcdir)/aclocal.m4
 am__aclocal_m4_deps = $(top_srcdir)/m4/libtool.m4 \
 	$(top_srcdir)/m4/ltoptions.m4 $(top_srcdir)/m4/ltsugar.m4 \
@@ -94,6 +95,8 @@ am__aclocal_m4_deps = $(top_srcdir)/m4/libtool.m4 \
 	$(top_srcdir)/configure.ac
 am__configure_deps = $(am__aclocal_m4_deps) $(CONFIGURE_DEPENDENCIES) \
 	$(ACLOCAL_M4)
+DIST_COMMON = $(srcdir)/Makefile.am $(top_srcdir)/configure \
+	$(am__configure_deps) $(am__DIST_COMMON)
 am__CONFIG_DISTCLEAN_FILES = config.status config.cache config.log \
  configure.lineno config.status.lineno
 mkinstalldirs = $(install_sh) -d
@@ -188,6 +191,14 @@ ETAGS = etags
 CTAGS = ctags
 CSCOPE = cscope
 DIST_SUBDIRS = $(SUBDIRS)
+am__DIST_COMMON = $(dist_man_MANS) $(srcdir)/Makefile.in \
+	$(srcdir)/config.h.in $(top_srcdir)/config/compile \
+	$(top_srcdir)/config/config.guess \
+	$(top_srcdir)/config/config.sub \
+	$(top_srcdir)/config/install-sh $(top_srcdir)/config/ltmain.sh \
+	$(top_srcdir)/config/missing ChangeLog config/compile \
+	config/config.guess config/config.sub config/install-sh \
+	config/ltmain.sh config/missing
 DISTFILES = $(DIST_COMMON) $(DIST_SOURCES) $(TEXINFOS) $(EXTRA_DIST)
 distdir = $(PACKAGE)-$(VERSION)
 top_distdir = $(distdir)
@@ -273,6 +284,7 @@ LIBTOOL = @LIBTOOL@
 LIPO = @LIPO@
 LN_S = @LN_S@
 LTLIBOBJS = @LTLIBOBJS@
+LT_SYS_LIBRARY_PATH = @LT_SYS_LIBRARY_PATH@
 MAKEINFO = @MAKEINFO@
 MANIFEST_TOOL = @MANIFEST_TOOL@
 MKDIR_P = @MKDIR_P@
@@ -374,7 +386,6 @@ $(srcdir)/Makefile.in:  $(srcdir)/Makefile.am  $(am__configure_deps)
 	echo ' cd $(top_srcdir) && $(AUTOMAKE) --foreign Makefile'; \
 	$(am__cd) $(top_srcdir) && \
 	  $(AUTOMAKE) --foreign Makefile
-.PRECIOUS: Makefile
 Makefile: $(srcdir)/Makefile.in $(top_builddir)/config.status
 	@case '$?' in \
 	  *config.status*) \
@@ -648,15 +659,15 @@ dist-xz: distdir
 	$(am__post_remove_distdir)
 
 dist-tarZ: distdir
-	@echo WARNING: "Support for shar distribution archives is" \
-	               "deprecated." >&2
+	@echo WARNING: "Support for distribution archives compressed with" \
+		       "legacy program 'compress' is deprecated." >&2
 	@echo WARNING: "It will be removed altogether in Automake 2.0" >&2
 	tardir=$(distdir) && $(am__tar) | compress -c >$(distdir).tar.Z
 	$(am__post_remove_distdir)
 
 dist-shar: distdir
-	@echo WARNING: "Support for distribution archives compressed with" \
-		       "legacy program 'compress' is deprecated." >&2
+	@echo WARNING: "Support for shar distribution archives is" \
+	               "deprecated." >&2
 	@echo WARNING: "It will be removed altogether in Automake 2.0" >&2
 	shar $(distdir) | GZIP=$(GZIP_ENV) gzip -c >$(distdir).shar.gz
 	$(am__post_remove_distdir)
@@ -692,17 +703,17 @@ distcheck: dist
 	esac
 	chmod -R a-w $(distdir)
 	chmod u+w $(distdir)
-	mkdir $(distdir)/_build $(distdir)/_inst
+	mkdir $(distdir)/_build $(distdir)/_build/sub $(distdir)/_inst
 	chmod a-w $(distdir)
 	test -d $(distdir)/_build || exit 0; \
 	dc_install_base=`$(am__cd) $(distdir)/_inst && pwd | sed -e 's,^[^:\\/]:[\\/],/,'` \
 	  && dc_destdir="$${TMPDIR-/tmp}/am-dc-$$$$/" \
 	  && am__cwd=`pwd` \
-	  && $(am__cd) $(distdir)/_build \
-	  && ../configure \
+	  && $(am__cd) $(distdir)/_build/sub \
+	  && ../../configure \
 	    $(AM_DISTCHECK_CONFIGURE_FLAGS) \
 	    $(DISTCHECK_CONFIGURE_FLAGS) \
-	    --srcdir=.. --prefix="$$dc_install_base" \
+	    --srcdir=../.. --prefix="$$dc_install_base" \
 	  && $(MAKE) $(AM_MAKEFLAGS) \
 	  && $(MAKE) $(AM_MAKEFLAGS) dvi \
 	  && $(MAKE) $(AM_MAKEFLAGS) check \
@@ -885,6 +896,8 @@ uninstall-man: uninstall-man8
 	mostlyclean-libtool pdf pdf-am ps ps-am tags tags-am uninstall \
 	uninstall-am uninstall-man uninstall-man8
 
+.PRECIOUS: Makefile
+
 
 # Tell versions [3.59,3.63) of GNU make to not export all variables.
 # Otherwise a system limit (for SysV at least) may be exceeded.

data/ext/nutcracker/README.md

@@ -1,30 +1,37 @@
 # twemproxy (nutcracker) [![Build Status](https://secure.travis-ci.org/twitter/twemproxy.png)](http://travis-ci.org/twitter/twemproxy)
 
-**twemproxy** (pronounced "two-em-proxy"), aka **nutcracker** is a fast and lightweight proxy for [memcached](http://www.memcached.org/) and [redis](http://redis.io/) protocol. It was primarily built to reduce the connection count on the backend caching servers.
+**twemproxy** (pronounced "two-em-proxy"), aka **nutcracker** is a fast and lightweight proxy for [memcached](http://www.memcached.org/) and [redis](http://redis.io/) protocol. It was built primarily to reduce the number of connections to the caching servers on the backend. This, together with protocol pipelining and sharding enables you to horizontally scale your distributed caching architecture.
 
 ## Build
 
-To build nutcracker from [distribution tarball](http://code.google.com/p/twemproxy/downloads/list):
+To build twemproxy from [distribution tarball](https://drive.google.com/open?id=0B6pVMMV5F5dfMUdJV25abllhUWM&authuser=0):
 
     $ ./configure
     $ make
     $ sudo make install
 
-To build nutcracker from [distribution tarball](http://code.google.com/p/twemproxy/downloads/list) in _debug mode_:
+To build twemproxy from [distribution tarball](https://drive.google.com/open?id=0B6pVMMV5F5dfMUdJV25abllhUWM&authuser=0) in _debug mode_:
 
     $ CFLAGS="-ggdb3 -O0" ./configure --enable-debug=full
     $ make
     $ sudo make install
 
-To build nutcracker from source with _debug logs enabled_ and _assertions disabled_:
+To build twemproxy from source with _debug logs enabled_ and _assertions enabled_:
 
     $ git clone git@github.com:twitter/twemproxy.git
     $ cd twemproxy
     $ autoreconf -fvi
-    $ ./configure --enable-debug=log
+    $ ./configure --enable-debug=full
     $ make
     $ src/nutcracker -h
 
+A quick checklist:
+
++ Use newer version of gcc (older version of gcc has problems)
++ Use CFLAGS="-O1" ./configure && make
++ Use CFLAGS="-O3 -fno-strict-aliasing" ./configure && make
++ `autoreconf -fvi && ./configure` needs `automake` and `libtool` to be installed
+
 ## Features
 
 + Fast.
@@ -35,12 +42,12 @@ To build nutcracker from source with _debug logs enabled_ and _assertions disabl
 + Supports proxying to multiple servers.
 + Supports multiple server pools simultaneously.
 + Shard data automatically across multiple servers.
-+ Implements the complete [memcached ascii](notes/memcache.txt) and [redis](notes/redis.md) protocol.
++ Implements the complete [memcached ascii](notes/memcache.md) and [redis](notes/redis.md) protocol.
 + Easy configuration of server pools through a YAML file.
 + Supports multiple hashing modes including consistent hashing and distribution.
 + Can be configured to disable nodes on failures.
-+ Observability through stats exposed on stats monitoring port.
-+ Works with Linux, *BSD, OS X and Solaris (SmartOS)
++ Observability via stats exposed on the stats monitoring port.
++ Works with Linux, *BSD, OS X and SmartOS (Solaris)
 
 ## Help
 
@@ -54,7 +61,7 @@ To build nutcracker from source with _debug logs enabled_ and _assertions disabl
       -t, --test-conf        : test configuration for syntax errors and exit
       -d, --daemonize        : run as a daemon
       -D, --describe-stats   : print stats description and exit
-      -v, --verbosity=N      : set logging level (default: 5, min: 0, max: 11)
+      -v, --verbose=N        : set logging level (default: 5, min: 0, max: 11)
       -o, --output=S         : set logging file (default: stderr)
       -c, --conf-file=S      : set configuration file (default: conf/nutcracker.yml)
       -s, --stats-port=N     : set stats monitoring port (default: 22222)
@@ -65,15 +72,15 @@ To build nutcracker from source with _debug logs enabled_ and _assertions disabl
 
 ## Zero Copy
 
-In nutcracker, all the memory for incoming requests and outgoing responses is allocated in mbuf. Mbuf enables zero-copy because the same buffer on which a request was received from the client is used for forwarding it to the server. Similarly the same mbuf on which a response was received from the server is used for forwarding it to the client.
+In twemproxy, all the memory for incoming requests and outgoing responses is allocated in mbuf. Mbuf enables zero-copy because the same buffer on which a request was received from the client is used for forwarding it to the server. Similarly the same mbuf on which a response was received from the server is used for forwarding it to the client.
 
-Furthermore, memory for mbufs is managed using a reuse pool. This means that once mbuf is allocated, it is not deallocated, but just put back into the reuse pool. By default each mbuf chunk is set to 16K bytes in size. There is a trade-off between the mbuf size and number of concurrent connections nutcracker can support. A large mbuf size reduces the number of read syscalls made by nutcracker when reading requests or responses. However, with large mbuf size, every active connection would use up 16K bytes of buffer which might be an issue when nutcracker is handling large number of concurrent connections from clients. When nutcracker is meant to handle a large number of concurrent client connections, you should set chunk size to a small value like 512 bytes using the -m or --mbuf-size=N argument.
+Furthermore, memory for mbufs is managed using a reuse pool. This means that once mbuf is allocated, it is not deallocated, but just put back into the reuse pool. By default each mbuf chunk is set to 16K bytes in size. There is a trade-off between the mbuf size and number of concurrent connections twemproxy can support. A large mbuf size reduces the number of read syscalls made by twemproxy when reading requests or responses. However, with a large mbuf size, every active connection would use up 16K bytes of buffer which might be an issue when twemproxy is handling large number of concurrent connections from clients. When twemproxy is meant to handle a large number of concurrent client connections, you should set chunk size to a small value like 512 bytes using the -m or --mbuf-size=N argument.
 
 ## Configuration
 
-nutcracker can be configured through a YAML file specified by the -c or --conf-file command-line argument on process start. The configuration file is used to specify the server pools and the servers within each pool that nutcracker manages. The configuration files parses and understands the following keys:
+Twemproxy can be configured through a YAML file specified by the -c or --conf-file command-line argument on process start. The configuration file is used to specify the server pools and the servers within each pool that twemproxy manages. The configuration files parses and understands the following keys:
 
-+ **listen**: The listening address and port (name:port or ip:port) for this server pool.
++ **listen**: The listening address and port (name:port or ip:port) or an absolute path to sock file (e.g. /var/run/nutcracker.sock) for this server pool.
 + **hash**: The name of the hash function. Possible values are:
  + one_at_a_time
  + md5
@@ -87,15 +94,17 @@ nutcracker can be configured through a YAML file specified by the -c or --conf-f
  + hsieh
  + murmur
  + jenkins
-+ **hash_tag**: A two character string that specifies the part of the key used for hashing. Eg "{}" or "$$". [Hash tag](notes/recommendation.md#hash-tags)  enable mapping different keys to the same server as long as the part of the key within the tag is the same.
++ **hash_tag**: A two character string that specifies the part of the key used for hashing. Eg "{}" or "$$". [Hash tag](notes/recommendation.md#hash-tags) enable mapping different keys to the same server as long as the part of the key within the tag is the same.
 + **distribution**: The key distribution mode. Possible values are:
  + ketama
  + modula
  + random
 + **timeout**: The timeout value in msec that we wait for to establish a connection to the server or receive a response from a server. By default, we wait indefinitely.
 + **backlog**: The TCP backlog argument. Defaults to 512.
-+ **preconnect**: A boolean value that controls if nutcracker should preconnect to all the servers in this pool on process start. Defaults to false.
++ **preconnect**: A boolean value that controls if twemproxy should preconnect to all the servers in this pool on process start. Defaults to false.
 + **redis**: A boolean value that controls if a server pool speaks redis or memcached protocol. Defaults to false.
++ **redis_auth**: Authenticate to the Redis server on connect.
++ **redis_db**: The DB number to use on the pool servers. Defaults to 0. Note: Twemproxy will always present itself to clients as DB 0.
 + **server_connections**: The maximum number of connections that can be opened to each server. By default, we open at most 1 server connection.
 + **auto_eject_hosts**: A boolean value that controls if server should be ejected temporarily when it fails consecutively server_failure_limit times. See [liveness recommendations](notes/recommendation.md#liveness) for information. Defaults to false.
 + **server_retry_timeout**: The timeout value in msec to wait for before retrying on a temporarily ejected server, when auto_eject_host is set to true. Defaults to 30000 msec.
@@ -103,7 +112,7 @@ nutcracker can be configured through a YAML file specified by the -c or --conf-f
 + **servers**: A list of server address, port and weight (name:port:weight or ip:port:weight) for this server pool.
 
 
-For example, the configuration file in [conf/nutcracker.yml](conf/nutcracker.yml), also shown below, configures 5 server pools with names - _alpha_, _beta_, _gamma_, _delta_ and omega. Clients that intend to send requests to one of the 10 servers in pool delta connect to port 22124 on 127.0.0.1. Clients that intend to send request to one of 2 servers in pool omega connect to unix path /tmp/gamma. Requests sent to pool alpha and omega have no timeout and might require timeout functionality to be implemented on the client side. On the other hand, requests sent to pool beta, gamma and delta timeout after 400 msec, 400 msec and 100 msec respectively when no response is received from the server. Of the 5 server pools, only pools alpha, gamma and delta are configured to use server ejection and hence are resilient to server failures. All the 5 server pools use ketama consistent hashing for key distribution with the key hasher for pools alpha, beta, gamma and delta set to fnv1a_64 while that for pool omega set to hsieh. Also only pool beta uses [nodes names](notes/recommendation.md#node-names-for-consistent-hashing) for consistent hashing, while pool alpha, gamma, delta and omega use 'host:port:weight' for consistent hashing. Finally, only pool alpha and beta can speak redis protocol, while pool gamma, deta and omega speak memcached protocol.
+For example, the configuration file in [conf/nutcracker.yml](conf/nutcracker.yml), also shown below, configures 5 server pools with names - _alpha_, _beta_, _gamma_, _delta_ and omega. Clients that intend to send requests to one of the 10 servers in pool delta connect to port 22124 on 127.0.0.1. Clients that intend to send request to one of 2 servers in pool omega connect to unix path /tmp/gamma. Requests sent to pool alpha and omega have no timeout and might require timeout functionality to be implemented on the client side. On the other hand, requests sent to pool beta, gamma and delta timeout after 400 msec, 400 msec and 100 msec respectively when no response is received from the server. Of the 5 server pools, only pools alpha, gamma and delta are configured to use server ejection and hence are resilient to server failures. All the 5 server pools use ketama consistent hashing for key distribution with the key hasher for pools alpha, beta, gamma and delta set to fnv1a_64 while that for pool omega set to hsieh. Also only pool beta uses [nodes names](notes/recommendation.md#node-names-for-consistent-hashing) for consistent hashing, while pool alpha, gamma, delta and omega use 'host:port:weight' for consistent hashing. Finally, only pool alpha and beta can speak the redis protocol, while pool gamma, deta and omega speak memcached protocol.
 
     alpha:
       listen: 127.0.0.1:22121
@@ -173,13 +182,13 @@ For example, the configuration file in [conf/nutcracker.yml](conf/nutcracker.yml
        - 127.0.0.1:11214:100000
        - 127.0.0.1:11215:1
 
-Finally, to make writing syntactically correct configuration file easier, nutcracker provides a command-line argument -t or --test-conf that can be used to test the YAML configuration file for any syntax error.
+Finally, to make writing a syntactically correct configuration file easier, twemproxy provides a command-line argument -t or --test-conf that can be used to test the YAML configuration file for any syntax error.
 
 ## Observability
 
-Observability in nutcracker is through logs and stats.
+Observability in twemproxy is through logs and stats.
 
-Nutcracker exposes stats at the granularity of server pool and servers per pool through the stats monitoring port. The stats are essentially JSON formatted key-value pairs, with the keys corresponding to counter names. By default stats are exposed on port 22222 and aggregated every 30 seconds. Both these values can be configured on program start using the -c or --conf-file and -i or --stats-interval command-line arguments respectively. You can print the description of all stats exported by nutcracker using the -D or --describe-stats command-line argument.
+Twemproxy exposes stats at the granularity of server pool and servers per pool through the stats monitoring port. The stats are essentially JSON formatted key-value pairs, with the keys corresponding to counter names. By default stats are exposed on port 22222 and aggregated every 30 seconds. Both these values can be configured on program start using the -c or --conf-file and -i or --stats-interval command-line arguments respectively. You can print the description of all stats exported by  using the -D or --describe-stats command-line argument.
 
     $ nutcracker --describe-stats
 
@@ -205,20 +214,31 @@ Nutcracker exposes stats at the granularity of server pool and servers per pool
       out_queue           "# requests in outgoing queue"
       out_queue_bytes     "current request bytes in outgoing queue"
 
-Logging in nutcracker is only available when nutcracker is built with logging enabled. By default logs are written to stderr. Nutcracker can also be configured to write logs to a specific file through the -o or --output command-line argument. On a running nutcracker, we can turn log levels up and down by sending it SIGTTIN and SIGTTOU signals respectively and reopen log files by sending it SIGHUP signal.
+Logging in twemproxy is only available when twemproxy is built with logging enabled. By default logs are written to stderr. Twemproxy can also be configured to write logs to a specific file through the -o or --output command-line argument. On a running twemproxy, we can turn log levels up and down by sending it SIGTTIN and SIGTTOU signals respectively and reopen log files by sending it SIGHUP signal.
 
 ## Pipelining
 
+Twemproxy enables proxying multiple client connections onto one or few server connections. This architectural setup makes it ideal for pipelining requests and responses and hence saving on the round trip time.
 
-Nutcracker enables proxying multiple client connections onto one or few server connections. This architectural setup makes it ideal for pipelining requests and responses and hence saving on the round trip time.
-
-For example, if nutcracker is proxying three client connections onto a single server and we get requests - 'get key\r\n', 'set key 0 0 3\r\nval\r\n' and 'delete key\r\n' on these three connections respectively, nutcracker would try to batch these requests and send them as a single message onto the server connection as 'get key\r\nset key 0 0 3\r\nval\r\ndelete key\r\n'.
+For example, if twemproxy is proxying three client connections onto a single server and we get requests - 'get key\r\n', 'set key 0 0 3\r\nval\r\n' and 'delete key\r\n' on these three connections respectively, twemproxy would try to batch these requests and send them as a single message onto the server connection as 'get key\r\nset key 0 0 3\r\nval\r\ndelete key\r\n'.
 
-Pipelining is the reason why nutcracker ends up doing better in terms of throughput even though it introduces an extra hop between the client and server.
+Pipelining is the reason why twemproxy ends up doing better in terms of throughput even though it introduces an extra hop between the client and server.
 
 ## Deployment
 
-If you are deploying nutcracker in production, you might consider reading through the [recommendation document](notes/recommendation.md) to understand the parameters you could tune in nutcracker to run it efficiently in the production environment.
+If you are deploying twemproxy in production, you might consider reading through the [recommendation document](notes/recommendation.md) to understand the parameters you could tune in twemproxy to run it efficiently in the production environment.
+
+## Packages
+
+### Ubuntu
+
+#### PPA Stable
+
+https://launchpad.net/~twemproxy/+archive/ubuntu/stable
+
+#### PPA Daily
+
+https://launchpad.net/~twemproxy/+archive/ubuntu/daily
 
 ## Utils
 + [nagios checks](https://github.com/wanelo/nagios-checks/blob/master/check_twemproxy)
@@ -231,8 +251,11 @@ If you are deploying nutcracker in production, you might consider reading throug
 + [sensu-metrics](https://github.com/sensu/sensu-community-plugins/blob/master/plugins/twemproxy/twemproxy-metrics.rb)
 + [redis-mgr](https://github.com/idning/redis-mgr)
 + [smitty for twemproxy failover](https://github.com/areina/smitty)
++ [Beholder, a Python agent for twemproxy failover](https://github.com/Serekh/beholder)
++ [chef cookbook](https://supermarket.getchef.com/cookbooks/twemproxy)
++ [twemsentinel] (https://github.com/yak0/twemsentinel)
 
-## Users
+## Companies using Twemproxy in Production
 + [Pinterest](http://pinterest.com/)
 + [Tumblr](https://www.tumblr.com/)
 + [Twitter](https://twitter.com/)
@@ -250,6 +273,18 @@ If you are deploying nutcracker in production, you might consider reading throug
 + [3scale.net](http://3scale.net)
 + [Ooyala](http://www.ooyala.com)
 + [Twitch](http://twitch.tv)
++ [Socrata](http://www.socrata.com/)
++ [Hootsuite](http://hootsuite.com/)
++ [Trivago](http://www.trivago.com/)
++ [Machinezone](http://www.machinezone.com)
++ [Flickr](https://www.flickr.com)
++ [Yahoo!](https://www.yahoo.com)
++ [Path](https://path.com)
++ [AOL](http://engineering.aol.com/)
++ [Soysuper](https://soysuper.com/)
++ [Vinted](http://vinted.com/)
++ [Poshmark](https://poshmark.com/)
++ [FanDuel](https://www.fanduel.com/)
 
 ## Issues and Support