nutcracker 0.2.3

data/ext/nutcracker/notes/debug.txt

@@ -0,0 +1,96 @@
+- strace
+  strace -o strace.txt -ttT -s 1024 -p `pgrep nutcracker`
+
+- epoll
+
+  EPOLLIN     = 0x001,
+  EPOLLPRI    = 0x002,
+  EPOLLOUT    = 0x004,
+  EPOLLERR    = 0x008,
+  EPOLLHUP    = 0x010,
+  EPOLLRDNORM = 0x040,
+  EPOLLRDBAND = 0x080,
+  EPOLLWRNORM = 0x100,
+  EPOLLWRBAND = 0x200,
+  EPOLLMSG    = 0x400,
+  EPOLLRDHUP  = 0x2000,
+  EPOLLONESHOT = (1 << 30),
+  EPOLLET = (1 << 31)
+
+- libyaml (yaml-0.1.4)
+
+  - yaml tokens:
+
+  0  YAML_NO_TOKEN,
+  1  YAML_STREAM_START_TOKEN,
+  2  YAML_STREAM_END_TOKEN,
+  3  YAML_VERSION_DIRECTIVE_TOKEN,
+  4  YAML_TAG_DIRECTIVE_TOKEN,
+  5  YAML_DOCUMENT_START_TOKEN,
+  6  YAML_DOCUMENT_END_TOKEN,
+  7  YAML_BLOCK_SEQUENCE_START_TOKEN,
+  8  YAML_BLOCK_MAPPING_START_TOKEN,
+  9  YAML_BLOCK_END_TOKEN,
+  10 YAML_FLOW_SEQUENCE_START_TOKEN,
+  11 YAML_FLOW_SEQUENCE_END_TOKEN,
+  12 YAML_FLOW_MAPPING_START_TOKEN,
+  13 YAML_FLOW_MAPPING_END_TOKEN,
+  14 YAML_BLOCK_ENTRY_TOKEN,
+  15 YAML_FLOW_ENTRY_TOKEN,
+  16 YAML_KEY_TOKEN,
+  17 YAML_VALUE_TOKEN,
+  18 YAML_ALIAS_TOKEN,
+  19 YAML_ANCHOR_TOKEN,
+  20 YAML_TAG_TOKEN,
+  21 YAML_SCALAR_TOKEN
+
+  - yaml events
+
+  0  YAML_NO_EVENT,
+  1  YAML_STREAM_START_EVENT,
+  2  YAML_STREAM_END_EVENT,
+  3  YAML_DOCUMENT_START_EVENT,
+  4  YAML_DOCUMENT_END_EVENT,
+  5  YAML_ALIAS_EVENT,
+  6  YAML_SCALAR_EVENT,
+  7  YAML_SEQUENCE_START_EVENT,
+  8  YAML_SEQUENCE_END_EVENT,
+  9  YAML_MAPPING_START_EVENT,
+  10 YAML_MAPPING_END_EVENT
+
+- sys/queue.h
+
+  queue.h is a generic linked list library adapted from BSD. It has three
+  macro knobs that are useful for debugging:
+
+  - QUEUE_MACRO_SCRUB nullifies links (next and prev pointers) of deleted
+    elements and catches cases where we are attempting to do operations
+    on an element that has already been unlinked.
+  - QUEUE_MACRO_TRACE keeps track of __FILE__ and __LINE__ of last two
+    updates to the list data structure.
+  - QUEUE_MACRO_ASSERT verifies the sanity of list data structure on every
+    operation.
+
+- valgrind
+  valgrind --tool=memcheck --leak-check=yes <program>
+
+- Core dump
+  ulimit -c unlimited
+
+- Generate ENOMEM to test "Out of Memory"
+  ulimit -m <size>    # limit maximum memory size
+  ulimit -v <size>    # limit virtual memory
+
+- get nutcracker stats
+  printf "" | socat  - TCP:localhost:22222 | tee stats.txt
+  printf "" | nc localhost 22222 | python -mjson.tool
+
+- Signalling and Logging
+  SIGTTIN - To up the log level
+  SIGTTOU - To down the log level
+  SIGHUP  - To reopen log file
+
+- Error codes:
+  http://www.cs.utah.edu/dept/old/texinfo/glibc-manual-0.02/library_2.html
+  /usr/include/asm-generic/errno-base.h
+  /usr/include/asm-generic/errno.h

data/ext/nutcracker/notes/memcache.txt

@@ -0,0 +1,123 @@
+- ascii:
+
+- Storage Commands (set, add, replace, append, prepend, cas):
+
+  set <key> <flags> <expiry> <datalen> [noreply]\r\n<data>\r\n
+  add <key> <flags> <expiry> <datalen> [noreply]\r\n<data>\r\n
+  replace <key> <flags> <expiry> <datalen> [noreply]\r\n<data>\r\n
+  append <key> <flags> <expiry> <datalen> [noreply]\r\n<data>\r\n
+  prepend <key> <flags> <expiry> <datalen> [noreply]\r\n<data>\r\n
+
+  cas <key> <flags> <expiry> <datalen> <cas> [noreply]\r\n<data>\r\n
+
+  where,
+  <flags>   - uint32_t : data specific client side flags
+  <expiry>  - uint32_t : expiration time (in seconds)
+  <datalen> - uint32_t : size of the data (in bytes)
+  <data>    - uint8_t[]: data block
+  <cas>     - uint64_t
+
+- Retrival Commands (get, gets):
+
+  get <key>\r\n
+  get <key> [<key>]+\r\n
+
+  gets <key>\r\n
+  gets <key> [<key>]+\r\n
+
+- Delete Command (delete):
+
+  delete <key> [noreply]\r\n
+
+- Arithmetic Commands (incr, decr):
+
+  incr <key> <value> [noreply]\r\n
+  decr <key> <value> [noreply]\r\n
+
+  where,
+  <value> - uint64_t
+
+- Misc Commands (quit)
+
+  quit\r\n
+  flush_all [<delay>] [noreply]\r\n
+  version\r\n
+  verbosity <num> [noreply]\r\n
+
+- Statistics Commands
+
+  stats\r\n
+  stats <args>\r\n
+
+- Error Responses:
+
+  ERROR\r\n
+  CLIENT_ERROR [error]\r\n
+  SERVER_ERROR [error]\r\n
+
+  where,
+  ERROR means client sent a non-existent command name
+  CLIENT_ERROR means that command sent by the client does not conform to the protocol
+  SERVER_ERROR means that there was an error on the server side that made processing of the command impossible
+
+- Storage Command Responses:
+
+  STORED\r\n
+  NOT_STORED\r\n
+  EXISTS\r\n
+  NOT_FOUND\r\n
+
+  where,
+  STORED indicates success.
+  NOT_STORED indicates the data was not stored because condition for an add or replace wasn't met.
+  EXISTS indicates that the item you are trying to store with a cas has been modified since you last fetched it.
+  NOT_FOUND indicates that the item you are trying to store with a cas does not exist.
+
+- Delete Command Response:
+
+  NOT_FOUND\r\n
+  DELETED\r\n
+
+- Retrival Responses:
+
+  END\r\n
+  VALUE <key> <flags> <datalen> [<cas>]\r\n<data>\r\nEND\r\n
+  VALUE <key> <flags> <datalen> [<cas>]\r\n<data>\r\n[VALUE <key> <flags> <datalen> [<cas>]\r\n<data>]+\r\nEND\r\n
+
+- Arithmetic Responses:
+
+  NOT_FOUND\r\n
+  <value>\r\n
+
+  where,
+  <value> - uint64_t : new key value after incr or decr operation
+
+- Statistics Response
+  [STAT <name> <value>\r\n]+END\r\n
+
+- Misc Response
+
+  OK\r\n
+  VERSION <version>\r\n
+
+- Notes:
+  - set always creates mapping irrespective of whether it is present on not.
+  - add, adds only if the mapping is not present
+  - replace, only replaces if the mapping is present
+  - append and prepend command ignore flags and expiry values
+  - noreply instructs the server to not send the reply even if there is an error.
+  - decr of 0 is 0, while incr of UINT64_MAX is 0
+  - maximum length of the key is 250 characters
+  - expiry of 0 means that item never expires, though it could be evicted from the cache
+  - non-zero expiry is either unix time (# seconds since 01/01/1970) or,
+    offset in seconds from the current time (< 60 x 60 x 24 x 30 seconds = 30 days)
+  - expiry time is with respect to the server (not client)
+  - <datalen> can be zero and when it is, the <data> block is empty.
+
+- Thoughts:
+  - ascii protocol is easier to debug - think using strace or tcpdump to see
+    protocol on the wire, Or using telnet or netcat or socat to build memcache
+    requests and responses
+    http://stackoverflow.com/questions/2525188/are-binary-protocols-dead
+
+  - http://news.ycombinator.com/item?id=1712788

data/ext/nutcracker/notes/recommendation.md

@@ -0,0 +1,118 @@
+If you are deploying nutcracker in your production environment, here are a few recommendations that might be worth considering.
+
+## Log Level
+
+By default debug logging is disabled in nutcracker. However, it is worthwhile running nutcracker with debug logging enabled and verbosity level set to LOG_INFO (-v 6 or --verbosity=6). This in reality does not add much overhead as you only pay the cost of checking an if condition for every log line encountered during the run time.
+
+At LOG_INFO level, nutcracker logs the life cycle of every client and server connection and important events like the server being ejected from the hash ring and so on. Eg.
+
+    [Thu Aug  2 00:03:09 2012] nc_proxy.c:336 accepted c 7 on p 6 from '127.0.0.1:54009'
+    [Thu Aug  2 00:03:09 2012] nc_server.c:528 connected on s 8 to server '127.0.0.1:11211:1'
+    [Thu Aug  2 00:03:09 2012] nc_core.c:270 req 1 on s 8 timedout
+    [Thu Aug  2 00:03:09 2012] nc_core.c:207 close s 8 '127.0.0.1:11211' on event 0004 eof 0 done 0 rb 0 sb 20: Connection timed out
+    [Thu Aug  2 00:03:09 2012] nc_server.c:406 close s 8 schedule error for req 1 len 20 type 5 from c 7: Connection timed out
+    [Thu Aug  2 00:03:09 2012] nc_server.c:281 update pool 0 'alpha' to delete server '127.0.0.1:11211:1' for next 2 secs
+    [Thu Aug  2 00:03:10 2012] nc_connection.c:314 recv on sd 7 eof rb 20 sb 35
+    [Thu Aug  2 00:03:10 2012] nc_request.c:334 c 7 is done
+    [Thu Aug  2 00:03:10 2012] nc_core.c:207 close c 7 '127.0.0.1:54009' on event 0001 eof 1 done 1 rb 20 sb 35
+    [Thu Aug  2 00:03:11 2012] nc_proxy.c:336 accepted c 7 on p 6 from '127.0.0.1:54011'
+    [Thu Aug  2 00:03:11 2012] nc_server.c:528 connected on s 8 to server '127.0.0.1:11212:1'
+    [Thu Aug  2 00:03:12 2012] nc_connection.c:314 recv on sd 7 eof rb 20 sb 8
+    [Thu Aug  2 00:03:12 2012] nc_request.c:334 c 7 is done
+    [Thu Aug  2 00:03:12 2012] nc_core.c:207 close c 7 '127.0.0.1:54011' on event 0001 eof 1 done 1 rb 20 sb 8
+
+To enable debug logging, you have to compile nutcracker with logging enabled using --enable-debug=log configure option.
+
+## Liveness
+
+Failures are a fact of life, especially when things are distributed. To be resilient against failures, it is recommended that you configure the following keys for every server pool. Eg:
+
+    resilient_pool:
+      auto_eject_hosts: true
+      server_retry_timeout: 30000
+      server_failure_limit: 3
+
+Enabling `auto_eject_hosts:` ensures that a dead server can be ejected out of the hash ring after `server_failure_limit:` consecutive failures have been encountered on that said server. A non-zero `server_retry_timeout:` ensures that we don't incorrectly mark a server as dead forever especially when the failures were really transient. The combination of `server_retry_timeout:` and `server_failure_limit:` controls the tradeoff between resiliency to permanent and transient failures.
+
+To ensure that requests always succeed in the face of server ejections (`auto_eject_hosts:` is enabled), some form of retry must be implemented at the client layer since nutcracker itself does not retry a request. This client-side retry count must be greater than `server_failure_limit:` value, which ensures that the original request has a chance to make it to a live server.
+
+## Timeout
+
+It is always a good idea to configure nutcracker `timeout:` for every server pool, rather than purely relying on client-side timeouts. Eg:
+
+    resilient_pool_with_timeout:
+      auto_eject_hosts: true
+      server_retry_timeout: 30000
+      server_failure_limit: 3
+      timeout: 400
+
+Relying only on client-side timeouts has the adverse effect of the original request having timedout on the client to proxy connection, but still pending and outstanding on the proxy to server connection. This further gets exacerbated when client retries the original request.
+
+By default, nutcracker waits indefinitely for any request sent to the server. However, when `timeout:` key is configured, a requests for which no response is received from the server in `timeout:` msec is timedout and an error response `SERVER_ERROR Connection timed out\r\n` is sent back to the client.
+
+## Error Response
+
+Whenever a request encounters failure on a server we usually send to the client a response with the general form - `SERVER_ERROR <errno description>\r\n` (memcached) or `-ERR <errno description>` (redis). 
+
+For example, when a memcache server is down, this error response is usually:
+
++ `SERVER_ERROR Connection refused\r\n` or,
++ `SERVER_ERROR Connection reset by peer\r\n`
+
+When the request timedout, the response is usually:
+
++ `SERVER_ERROR Connection timed out\r\n`
+
+Seeing a `SERVER_ERROR` or `-ERR` response should be considered as a transient failure by a client which makes the original request an ideal candidate for a retry.
+
+## read, writev and mbuf
+
+All memory for incoming requests and outgoing responses is allocated in mbuf. Mbuf enables zero copy for requests and responses flowing through the proxy. By default an mbuf is 16K bytes in size and this value can be tuned between 512 and 65K bytes using -m or --mbuf-size=N argument. Every connection has at least one mbuf allocated to it. This means that the number of concurrent connections nutcracker can support is dependent on the mbuf size. A small mbuf allows us to handle more connections, while a large mbuf allows us to read and write more data to and from kernel socket buffers.
+
+If nutcracker is meant to handle a large number of concurrent client connections, you should set the mbuf size to 512 or 1K bytes.
+
+## Maximum Key Length
+The memcache ascii protocol [specification](https://github.com/twitter/twemproxy/blob/master/notes/memcache.txt) limits the maximum length of the key to 250 characters. The key should not include whitespace, or '\r' or '\n' character. For redis, we have no such limitation. However, nutcracker requires the key to be stored in a contiguous memory region. Since all requests and responses in nutcracker are stored in mbuf, the maximum length of the redis key is limited by the size of the maximum available space for data in mbuf (mbuf_data_size()). This means that if you want your redis instances to handle large keys, you might want to choose large mbuf size set using -m or --mbuf-size=N command-line argument.
+
+## Node Names for Consistent Hashing
+
+The server cluster in twemproxy can either be specified as list strings in format 'host:port:weight' or 'host:port:weight name'.
+
+    servers:
+     - 127.0.0.1:6379:1
+     - 127.0.0.1:6380:1
+     - 127.0.0.1:6381:1
+     - 127.0.0.1:6382:1
+
+Or,
+
+    servers:
+     - 127.0.0.1:6379:1 server1
+     - 127.0.0.1:6380:1 server2
+     - 127.0.0.1:6381:1 server3
+     - 127.0.0.1:6382:1 server4
+
+
+In the former configuration, keys are mapped **directly** to **'host:port:weight'** triplet and in the latter they are mapped to **node names** which are then mapped to nodes i.e. host:port pair. The latter configuration gives us the freedom to relocate nodes to a different server without disturbing the hash ring and hence makes this configuration ideal when auto_eject_hosts is set to false. See [issue 25](https://github.com/twitter/twemproxy/issues/25) for details.
+
+Note that when using node names for consistent hashing, twemproxy ignores the weight value in the 'host:port:weight name' format string.
+
+## Hash Tags
+
+[Hash Tags](http://antirez.com/post/redis-presharding.html) enables you to use part of the key for calculating the hash. When the hash tag is present, we use part of the key within the tag as the key to be used for consistent hashing. Otherwise, we use the full key as is. Hash tags enable you to map different keys to the same server as long as the part of the key within the tag is the same.
+
+For example, the configuration of server pool _beta_, aslo shown below, specifies a two character hash_tag string - "{}". This means that keys "user:{user1}:ids" and "user:{user1}:tweets" map to the same server because we compute the hash on "user1". For a key like "user:user1:ids", we use the entire string "user:user1:ids" to compute the hash and it may map to a different server.
+
+    beta:
+      listen: 127.0.0.1:22122
+      hash: fnv1a_64
+      hash_tag: "{}"
+      distribution: ketama
+      auto_eject_hosts: false
+      timeout: 400
+      redis: true
+      servers:
+       - 127.0.0.1:6380:1 server1
+       - 127.0.0.1:6381:1 server2
+       - 127.0.0.1:6382:1 server3
+       - 127.0.0.1:6383:1 server4

data/ext/nutcracker/notes/redis.md

@@ -0,0 +1,415 @@
+## Redis Commands Supported
+
+### Keys Command
+
+    +-------------------+------------+---------------------------------------------------------------------------------------------------------------------+
+    |      Command      | Supported? | Format                                                                                                              |
+    +-------------------+------------+---------------------------------------------------------------------------------------------------------------------+
+    |        DEL        |    Yes     | DEL key [key …]                                                                                                     |
+    +-------------------+------------+---------------------------------------------------------------------------------------------------------------------+
+    |       DUMP        |    No      | DUMP key                                                                                                            |
+    +-------------------+------------+---------------------------------------------------------------------------------------------------------------------+
+    |      EXISTS       |    Yes     | EXISTS key                                                                                                          |
+    +-------------------+------------+---------------------------------------------------------------------------------------------------------------------+
+    |      EXPIRE       |    Yes     | EXPIRE key seconds                                                                                                  |
+    +-------------------+------------+---------------------------------------------------------------------------------------------------------------------+
+    |     EXPIREAT      |    Yes     | EXPIREAT key timestamp                                                                                              |
+    +-------------------+------------+---------------------------------------------------------------------------------------------------------------------+
+    |       KEYS        |    No      | KEYS pattern                                                                                                        |
+    +-------------------+------------+---------------------------------------------------------------------------------------------------------------------+
+    |      MIGRATE      |    No      | MIGRATE host port key destination-db timeout                                                                        |
+    +-------------------+------------+---------------------------------------------------------------------------------------------------------------------+
+    |       MOVE        |    No      | MOVE key db                                                                                                         |
+    +-------------------+------------+---------------------------------------------------------------------------------------------------------------------+
+    |      OBJECT       |    No      | OBJECT subcommand [arguments [arguments …]]                                                                         |
+    +-------------------+------------+---------------------------------------------------------------------------------------------------------------------+
+    |      PERSIST      |    Yes     | PERSIST key                                                                                                         |
+    +-------------------+------------+---------------------------------------------------------------------------------------------------------------------+
+    |      PEXPIRE      |    Yes     | PEXPIRE key milliseconds                                                                                            |
+    +-------------------+------------+---------------------------------------------------------------------------------------------------------------------+
+    |     PEXPIREAT     |    Yes     | PEXPIREAT key milliseconds-timestamp                                                                                |
+    +-------------------+------------+---------------------------------------------------------------------------------------------------------------------+
+    |      PTTL         |    Yes     | PTTL key                                                                                                            |
+    +-------------------+------------+---------------------------------------------------------------------------------------------------------------------+
+    |     RANDOMKEY     |    No      | RANDOMKEY                                                                                                           |
+    +-------------------+------------+---------------------------------------------------------------------------------------------------------------------+
+    |      RENAME       |    No      | RENAME key newkey                                                                                                   |
+    +-------------------+------------+---------------------------------------------------------------------------------------------------------------------+
+    |     RENAMENX      |    No      | RENAMENX key newkey                                                                                                 |
+    +-------------------+------------+---------------------------------------------------------------------------------------------------------------------+
+    |      RESTORE      |    No      | RESTORE key ttl serialized-value                                                                                    |
+    +-------------------+------------+---------------------------------------------------------------------------------------------------------------------+
+    |      SORT         |    No      | SORT key [BY pattern] [LIMIT offset count] [GET pattern [GET pattern ...]] [ASC|DESC] [ALPHA] [STORE destination]   |
+    +-------------------+------------+---------------------------------------------------------------------------------------------------------------------+
+    |       TTL         |    Yes     | TTL key                                                                                                             |
+    +-------------------+------------+---------------------------------------------------------------------------------------------------------------------+
+    |      TYPE         |    Yes     | TYPE key                                                                                                            |
+    +-------------------+------------+---------------------------------------------------------------------------------------------------------------------+
+
+### Strings Command
+
+    +-------------------+------------+---------------------------------------------------------------------------------------------------------------------+
+    |      Command      | Supported? | Format                                                                                                              |
+    +-------------------+------------+---------------------------------------------------------------------------------------------------------------------+
+    |       APPEND      |    Yes     | APPEND key value                                                                                                    |
+    +-------------------+------------+---------------------------------------------------------------------------------------------------------------------+
+    |      BITCOUNT     |    Yes     | BITCOUNT key [start] [end]                                                                                          |
+    +-------------------+------------+---------------------------------------------------------------------------------------------------------------------+
+    |       BITOP       |    No      | BITOP operation destkey key [key ...]                                                                               |
+    +-------------------+------------+---------------------------------------------------------------------------------------------------------------------+
+    |       DECR        |    Yes     | DECR key                                                                                                            |
+    +-------------------+------------+---------------------------------------------------------------------------------------------------------------------+
+    |      DECRBY       |    Yes     | DECRBY key decrement                                                                                                |
+    +-------------------+------------+---------------------------------------------------------------------------------------------------------------------+
+    |       GET         |    Yes     | GET key                                                                                                             |
+    +-------------------+------------+---------------------------------------------------------------------------------------------------------------------+
+    |      GETBIT       |    Yes     | GETBIT key offset                                                                                                   |
+    +-------------------+------------+---------------------------------------------------------------------------------------------------------------------+
+    |     GETRANGE      |    Yes     | GETRANGE key start end                                                                                              |
+    +-------------------+------------+---------------------------------------------------------------------------------------------------------------------+
+    |      GETSET       |    Yes     | GETSET key value                                                                                                    |
+    +-------------------+------------+---------------------------------------------------------------------------------------------------------------------+
+    |      INCR         |    Yes     | INCR key                                                                                                            |
+    +-------------------+------------+---------------------------------------------------------------------------------------------------------------------+
+    |      INCRBY       |    Yes     | INCRBY key increment                                                                                                |
+    +-------------------+------------+---------------------------------------------------------------------------------------------------------------------+
+    |     INCRBYFLOAT   |    Yes     | INCRBYFLOAT key increment                                                                                           |
+    +-------------------+------------+---------------------------------------------------------------------------------------------------------------------+
+    |      MGET         |    Yes     | MGET key [key ...]                                                                                                  |
+    +-------------------+------------+---------------------------------------------------------------------------------------------------------------------+
+    |      MSET         |    No      | MSET key value [key value ...]                                                                                      |
+    +-------------------+------------+---------------------------------------------------------------------------------------------------------------------+
+    |      MSETNX       |    No      | MSETNX key value [key value ...]                                                                                    |
+    +-------------------+------------+---------------------------------------------------------------------------------------------------------------------+
+    |      PSETEX       |    Yes     | PSETEX key milliseconds value                                                                                       |
+    +-------------------+------------+---------------------------------------------------------------------------------------------------------------------+
+    |      SET          |    Yes     | SET key value                                                                                                       |
+    +-------------------+------------+---------------------------------------------------------------------------------------------------------------------+
+    |      SETBIT       |    Yes     | SETBIT key offset value                                                                                             |
+    +-------------------+------------+---------------------------------------------------------------------------------------------------------------------+
+    |      SETEX        |    Yes     | SETEX key seconds value                                                                                             |
+    +-------------------+------------+---------------------------------------------------------------------------------------------------------------------+
+    |      SETNX        |    Yes     | SETNX key value                                                                                                     |
+    +-------------------+------------+---------------------------------------------------------------------------------------------------------------------+
+    |      SETRANGE     |    Yes     | SETRANGE key offset value                                                                                           |
+    +-------------------+------------+---------------------------------------------------------------------------------------------------------------------+
+    |      STRLEN       |    Yes     | STRLEN key                                                                                                          |
+    +-------------------+------------+---------------------------------------------------------------------------------------------------------------------+
+
+### Hashes
+
+    +-------------------+------------+---------------------------------------------------------------------------------------------------------------------+
+    |      Command      | Supported? | Format                                                                                                              |
+    +-------------------+------------+---------------------------------------------------------------------------------------------------------------------+
+    |       HDEL        |    Yes     | HDEL key field [field ...]                                                                                          |
+    +-------------------+------------+---------------------------------------------------------------------------------------------------------------------+
+    |      HEXISTS      |    Yes     | HEXISTS key field                                                                                                   |
+    +-------------------+------------+---------------------------------------------------------------------------------------------------------------------+
+    |       HGET        |    Yes     | HGET key field                                                                                                      |
+    +-------------------+------------+---------------------------------------------------------------------------------------------------------------------+
+    |      HGETALL      |    Yes     | HGETALL key                                                                                                         |
+    +-------------------+------------+---------------------------------------------------------------------------------------------------------------------+
+    |      HINCRBY      |    Yes     | HINCRBY key field increment                                                                                         |
+    +-------------------+------------+---------------------------------------------------------------------------------------------------------------------+
+    |    HINCRBYFLOAT   |    Yes     | HINCRBYFLOAT key field increment                                                                                    |
+    +-------------------+------------+---------------------------------------------------------------------------------------------------------------------+
+    |      HKEYS        |    Yes     | HKEYS key                                                                                                           |
+    +-------------------+------------+---------------------------------------------------------------------------------------------------------------------+
+    |      HLEN         |    Yes     | HLEN key                                                                                                            |
+    +-------------------+------------+---------------------------------------------------------------------------------------------------------------------+
+    |      HMGET        |    Yes     | HMGET key field [field ...]                                                                                         |
+    +-------------------+------------+---------------------------------------------------------------------------------------------------------------------+
+    |      HMSET        |    Yes     | HMSET key field value [field value ...]                                                                             |
+    +-------------------+------------+---------------------------------------------------------------------------------------------------------------------+
+    |      HSET         |    Yes     | HSET key field value                                                                                                |
+    +-------------------+------------+---------------------------------------------------------------------------------------------------------------------+
+    |      HSETNX       |    Yes     | HSETNX key field value                                                                                              |
+    +-------------------+------------+---------------------------------------------------------------------------------------------------------------------+
+    |      HVALS        |    Yes     | HVALS key                                                                                                           |
+    +-------------------+------------+---------------------------------------------------------------------------------------------------------------------+
+
+### Lists
+
+    +-------------------+------------+---------------------------------------------------------------------------------------------------------------------+
+    |      Command      | Supported? | Format                                                                                                              |
+    +-------------------+------------+---------------------------------------------------------------------------------------------------------------------+
+    |       BLPOP       |    No      | BLPOP key [key ...] timeout                                                                                         |
+    +-------------------+------------+---------------------------------------------------------------------------------------------------------------------+
+    |       BRPOP       |    No      | BRPOP key [key ...] timeout                                                                                         |
+    +-------------------+------------+---------------------------------------------------------------------------------------------------------------------+
+    |     BRPOPLPUSH    |    No      | BRPOPLPUSH source destination timeout                                                                               |
+    +-------------------+------------+---------------------------------------------------------------------------------------------------------------------+
+    |      LINDEX       |    Yes     | LINDEX key index                                                                                                    |
+    +-------------------+------------+---------------------------------------------------------------------------------------------------------------------+
+    |      LINSERT      |    Yes     | LINSERT key BEFORE|AFTER pivot value                                                                                |
+    +-------------------+------------+---------------------------------------------------------------------------------------------------------------------+
+    |      LLEN         |    Yes     | LLEN key                                                                                                            |
+    +-------------------+------------+---------------------------------------------------------------------------------------------------------------------+
+    |      LPOP         |    Yes     | LPOP key                                                                                                            |
+    +-------------------+------------+---------------------------------------------------------------------------------------------------------------------+
+    |      LPUSH        |    Yes     | LPUSH key value [value ...]                                                                                         |
+    +-------------------+------------+---------------------------------------------------------------------------------------------------------------------+
+    |      LPUSHX       |    Yes     | LPUSHX key value                                                                                                    |
+    +-------------------+------------+---------------------------------------------------------------------------------------------------------------------+
+    |      LRANGE       |    Yes     | LRANGE key start stop                                                                                               |
+    +-------------------+------------+---------------------------------------------------------------------------------------------------------------------+
+    |      LREM         |    Yes     | LREM key count value                                                                                                |
+    +-------------------+------------+---------------------------------------------------------------------------------------------------------------------+
+    |      LSET         |    Yes     | LSET key index value                                                                                                |
+    +-------------------+------------+---------------------------------------------------------------------------------------------------------------------+
+    |      LTRIM        |    Yes     | LTRIM key start stop                                                                                                |
+    +-------------------+------------+---------------------------------------------------------------------------------------------------------------------+
+    |      RPOP         |    Yes     | RPOP key                                                                                                            |
+    +-------------------+------------+---------------------------------------------------------------------------------------------------------------------+
+    |     RPOPLPUSH     |    Yes*    | RPOPLPUSH source destination                                                                                        |
+    +-------------------+------------+---------------------------------------------------------------------------------------------------------------------+
+    |      RPUSH        |    Yes     | RPUSH key value [value ...]                                                                                         |
+    +-------------------+------------+---------------------------------------------------------------------------------------------------------------------+
+    |      RPUSHX       |    Yes     | RPUSHX key value                                                                                                    |
+    +-------------------+------------+---------------------------------------------------------------------------------------------------------------------+
+
+* RPOPLPUSH support requires that source and destination keys hash to the same server. You can ensure this by using the same [hashtag](https://github.com/twitter/twemproxy/blob/master/notes/recommendation.md#hash-tags) for source and destination key. Twemproxy does no checking on its end to verify that source and destination key hash to the same server, and the RPOPLPUSH command is forwarded to the server that the source key hashes to
+
+### Sets
+
+    +-------------------+------------+---------------------------------------------------------------------------------------------------------------------+
+    |      Command      | Supported? | Format                                                                                                              |
+    +-------------------+------------+---------------------------------------------------------------------------------------------------------------------+
+    |      SADD         |    Yes     | SADD key member [member ...]                                                                                        |
+    +-------------------+------------+---------------------------------------------------------------------------------------------------------------------+
+    |      SCARD        |    Yes     | SCARD key                                                                                                           |
+    +-------------------+------------+---------------------------------------------------------------------------------------------------------------------+
+    |      SDIFF        |    Yes*    | SDIFF key [key ...]                                                                                                 |
+    +-------------------+------------+---------------------------------------------------------------------------------------------------------------------+
+    |     SDIFFSTORE    |    Yes*    | SDIFFSTORE destination key [key ...]                                                                                |
+    +-------------------+------------+---------------------------------------------------------------------------------------------------------------------+
+    |      SINTER       |    Yes*    | SINTER key [key ...]                                                                                                |
+    +-------------------+------------+---------------------------------------------------------------------------------------------------------------------+
+    |    SINTERSTORE    |    Yes*    | SINTERSTORE destination key [key ...]                                                                               |
+    +-------------------+------------+---------------------------------------------------------------------------------------------------------------------+
+    |     SISMEMBER     |    Yes     | SISMEMBER key member                                                                                                |
+    +-------------------+------------+---------------------------------------------------------------------------------------------------------------------+
+    |     SMEMBERS      |    Yes     | SMEMBERS key                                                                                                        |
+    +-------------------+------------+---------------------------------------------------------------------------------------------------------------------+
+    |      SMOVE        |    Yes*    | SMOVE source destination member                                                                                     |
+    +-------------------+------------+---------------------------------------------------------------------------------------------------------------------+
+    |      SPOP         |    Yes     | SPOP key                                                                                                            |
+    +-------------------+------------+---------------------------------------------------------------------------------------------------------------------+
+    |    SRANDMEMBER    |    Yes     | SRANDMEMBER key                                                                                                     |
+    +-------------------+------------+---------------------------------------------------------------------------------------------------------------------+
+    |      SREM         |    Yes     | SREM key member [member ...]                                                                                        |
+    +-------------------+------------+---------------------------------------------------------------------------------------------------------------------+
+    |     SUNION        |    Yes*    | SUNION key [key ...]                                                                                                |
+    +-------------------+------------+---------------------------------------------------------------------------------------------------------------------+
+    |   SUNIONSTORE     |    Yes*    | SUNIONSTORE destination key [key ...]                                                                               |
+    +-------------------+------------+---------------------------------------------------------------------------------------------------------------------+
+
+* SIDFF, SDIFFSTORE, SINTER, SINTERSTORE, SMOVE, SUNION and SUNIONSTORE support requires that the supplied keys hash to the same server. You can ensure this by using the same [hashtag](https://github.com/twitter/twemproxy/blob/master/notes/recommendation.md#hash-tags) for all keys in the command. Twemproxy does no checking on its end to verify that all the keys hash to the same server, and the given command is forwarded to the server that the first key hashes to.
+
+
+### Sorted Sets
+
+    +-------------------+------------+---------------------------------------------------------------------------------------------------------------------+
+    |      Command      | Supported? | Format                                                                                                              |
+    +-------------------+------------+---------------------------------------------------------------------------------------------------------------------+
+    |      ZADD         |    Yes     | ZADD key score member [score] [member]                                                                              |
+    +-------------------+------------+---------------------------------------------------------------------------------------------------------------------+
+    |      ZCARD        |    Yes     | ZCARD key                                                                                                           |
+    +-------------------+------------+---------------------------------------------------------------------------------------------------------------------+
+    |      ZCOUNT       |    Yes     | ZCOUNT key min max                                                                                                  |
+    +-------------------+------------+---------------------------------------------------------------------------------------------------------------------+
+    |      ZINCRBY      |    Yes     | ZINCRBY key increment member                                                                                        |
+    +-------------------+------------+---------------------------------------------------------------------------------------------------------------------+
+    |     ZINTERSTORE   |    Yes*    | ZINTERSTORE destination numkeys key [key ...] [WEIGHTS weight [weight ...]] [AGGREGATE SUM|MIN|MAX]                 |
+    +-------------------+------------+---------------------------------------------------------------------------------------------------------------------+
+    |      ZRANGE       |    Yes     | ZRANGE key start stop [WITHSCORES]                                                                                  |
+    +-------------------+------------+---------------------------------------------------------------------------------------------------------------------+
+    |    ZRANGEBYSCORE  |    Yes     | ZRANGEBYSCORE key min max [WITHSCORES] [LIMIT offset count]                                                         |
+    +-------------------+------------+---------------------------------------------------------------------------------------------------------------------+
+    |      ZRANK        |    Yes     | ZRANK key member                                                                                                    |
+    +-------------------+------------+---------------------------------------------------------------------------------------------------------------------+
+    |       ZREM        |    Yes     | ZREM key member [member ...]                                                                                        |
+    +-------------------+------------+---------------------------------------------------------------------------------------------------------------------+
+    |   ZREMRANGEBYRANK |    Yes     | ZREMRANGEBYRANK key start stop                                                                                      |
+    +-------------------+------------+---------------------------------------------------------------------------------------------------------------------+
+    |  ZREMRANGEBYSCORE |    Yes     | ZREMRANGEBYSCORE key min max                                                                                        |
+    +-------------------+------------+---------------------------------------------------------------------------------------------------------------------+
+    |    ZREVRANGE      |    Yes     | ZREVRANGE key start stop [WITHSCORES]                                                                               |
+    +-------------------+------------+---------------------------------------------------------------------------------------------------------------------+
+    |  ZREVRANGEBYSCORE |    Yes     | ZREVRANGEBYSCORE key max min [WITHSCORES] [LIMIT offset count]                                                      |
+    +-------------------+------------+---------------------------------------------------------------------------------------------------------------------+
+    |     ZREVRANK      |    Yes     | ZREVRANK key member                                                                                                 |
+    +-------------------+------------+---------------------------------------------------------------------------------------------------------------------+
+    |     ZSCORE        |    Yes     | ZSCORE key member                                                                                                   |
+    +-------------------+------------+---------------------------------------------------------------------------------------------------------------------+
+    |    ZUNIONSTORE    |    Yes*    | ZUNIONSTORE destination numkeys key [key ...] [WEIGHTS weight [weight ...]] [AGGREGATE SUM|MIN|MAX]                 |
+    +-------------------+------------+---------------------------------------------------------------------------------------------------------------------+
+
+* ZINTERSTORE and ZUNIONSTORE support requires that the supplied keys hash to the same server. You can ensure this by using the same [hashtag](https://github.com/twitter/twemproxy/blob/master/notes/recommendation.md#hash-tags) for all keys in the command. Twemproxy does no checking on its end to verify that all the keys hash to the same server, and the given command is forwarded to the server that the first key hashes to.
+
+
+### Pub/Sub
+
+    +-------------------+------------+---------------------------------------------------------------------------------------------------------------------+
+    |      Command      | Supported? | Format                                                                                                              |
+    +-------------------+------------+---------------------------------------------------------------------------------------------------------------------+
+    |     PSUBSCRIBE    |    No      | PSUBSCRIBE pattern [pattern ...]                                                                                    |
+    +-------------------+------------+---------------------------------------------------------------------------------------------------------------------+
+    |     PUBLISH       |    No      | PUBLISH channel message                                                                                             |
+    +-------------------+------------+---------------------------------------------------------------------------------------------------------------------+
+    |    PUNSUBSCRIBE   |    No      | PUNSUBSCRIBE [pattern [pattern ...]]                                                                                |
+    +-------------------+------------+---------------------------------------------------------------------------------------------------------------------+
+    |     SUBSCRIBE     |    No      | SUBSCRIBE channel [channel ...]                                                                                     |
+    +-------------------+------------+---------------------------------------------------------------------------------------------------------------------+
+    |     UNSUBSCRIBE   |    No      | UNSUBSCRIBE [channel [channel ...]]                                                                                 |
+    +-------------------+------------+---------------------------------------------------------------------------------------------------------------------+
+
+### Transactions
+
+    +-------------------+------------+---------------------------------------------------------------------------------------------------------------------+
+    |      Command      | Supported? | Format                                                                                                              |
+    +-------------------+------------+---------------------------------------------------------------------------------------------------------------------+
+    |      DISCARD      |    No      | DISCARD                                                                                                             |
+    +-------------------+------------+---------------------------------------------------------------------------------------------------------------------+
+    |       EXEC        |    No      | EXEC                                                                                                                |
+    +-------------------+------------+---------------------------------------------------------------------------------------------------------------------+
+    |       MULTI       |    No      | MULTI                                                                                                               |
+    +-------------------+------------+---------------------------------------------------------------------------------------------------------------------+
+    |      UNWATCH      |    No      | UNWATCH                                                                                                             |
+    +-------------------+------------+---------------------------------------------------------------------------------------------------------------------+
+    |       WATCH       |    No      | WATCH key [key ...]                                                                                                 |
+    +-------------------+------------+---------------------------------------------------------------------------------------------------------------------+
+
+### Scripting
+
+    +-------------------+------------+---------------------------------------------------------------------------------------------------------------------+
+    |      Command      | Supported? | Format                                                                                                              |
+    +-------------------+------------+---------------------------------------------------------------------------------------------------------------------+
+    |       EVAL        |    Yes*    | EVAL script numkeys key [key ...] arg [arg ...]                                                                     |
+    +-------------------+------------+---------------------------------------------------------------------------------------------------------------------+
+    |     EVALSHA       |    Yes*    | EVALSHA sha1 numkeys key [key ...] arg [arg ...]                                                                    |
+    +-------------------+------------+---------------------------------------------------------------------------------------------------------------------+
+    |    SCRIPT EXISTS  |    No      | SCRIPT EXISTS script [script ...]                                                                                   |
+    +-------------------+------------+---------------------------------------------------------------------------------------------------------------------+
+    |    SCRIPT FLUSH   |    No      | SCRIPT FLUSH                                                                                                        |
+    +-------------------+------------+---------------------------------------------------------------------------------------------------------------------+
+    |    SCRIPT KILL    |    No      | SCRIPT KILL                                                                                                         |
+    +-------------------+------------+---------------------------------------------------------------------------------------------------------------------+
+    |    SCRIPT LOAD    |    No      | SCRIPT LOAD script                                                                                                  |
+    +-------------------+------------+---------------------------------------------------------------------------------------------------------------------+
+   
+ * EVAL and EVALSHA support is limited to scripts that take at least 1 key. If multiple keys are used, all keys must hash to the same server. You can ensure this by using the same [hashtag](https://github.com/twitter/twemproxy/blob/master/notes/recommendation.md#hash-tags) for all keys. If you use more than 1 key, the proxy does no checking to verify that all keys hash to the same server, and the entire command is forwarded to the server that the first key hashes to
+
+### Connection
+
+    +-------------------+------------+---------------------------------------------------------------------------------------------------------------------+
+    |      Command      | Supported? | Format                                                                                                              |
+    +-------------------+------------+---------------------------------------------------------------------------------------------------------------------+
+    |       AUTH        |    No      | AUTH password                                                                                                       |
+    +-------------------+------------+---------------------------------------------------------------------------------------------------------------------+
+    |       ECHO        |    No      | ECHO message                                                                                                        |
+    +-------------------+------------+---------------------------------------------------------------------------------------------------------------------+
+    |       PING        |    No      | PING                                                                                                                |
+    +-------------------+------------+---------------------------------------------------------------------------------------------------------------------+
+    |       QUIT        |    No      | QUIT                                                                                                                |
+    +-------------------+------------+---------------------------------------------------------------------------------------------------------------------+
+    |      SELECT       |    No      | SELECT index                                                                                                        |
+    +-------------------+------------+---------------------------------------------------------------------------------------------------------------------+
+
+### Server
+
+    +-------------------+------------+---------------------------------------------------------------------------------------------------------------------+
+    |      Command      | Supported? | Format                                                                                                              |
+    +-------------------+------------+---------------------------------------------------------------------------------------------------------------------+
+    |    BGREWRITEAOF   |    No      | BGREWRITEAOF                                                                                                        |
+    +-------------------+------------+---------------------------------------------------------------------------------------------------------------------+
+    |      BGSAVE       |    No      | BGSAVE                                                                                                              |
+    +-------------------+------------+---------------------------------------------------------------------------------------------------------------------+
+    |    CLIENT KILL    |    No      | CLIENT KILL ip:port                                                                                                 |
+    +-------------------+------------+---------------------------------------------------------------------------------------------------------------------+
+    |    CLIENT LIST    |    No      | CLIENT LIST                                                                                                         |
+    +-------------------+------------+---------------------------------------------------------------------------------------------------------------------+
+    |    CONFIG GET     |    No      | CONFIG GET parameter                                                                                                |
+    +-------------------+------------+---------------------------------------------------------------------------------------------------------------------+
+    |    CONFIG SET     |    No      | CONFIG SET parameter value                                                                                          |
+    +-------------------+------------+---------------------------------------------------------------------------------------------------------------------+
+    |  CONFIG RESETSTAT |    No      | CONFIG RESETSTAT                                                                                                    |
+    +-------------------+-------------+--------------------------------------------------------------------------------------------------------------------+
+    |     DBSIZE        |    No      | DBSIZE                                                                                                              |
+    +-------------------+------------+---------------------------------------------------------------------------------------------------------------------+
+    |    DEBUG OBJECT   |    No      | DEBUG OBJECT key                                                                                                    |
+    +-------------------+------------+---------------------------------------------------------------------------------------------------------------------+
+    |    DEBUG SEGFAULT |    No      | DEBUG SEGFAULT                                                                                                      |
+    +-------------------+------------+---------------------------------------------------------------------------------------------------------------------+
+    |     FLUSHALL      |    No      | FLUSHALL                                                                                                            |
+    +-------------------+------------+---------------------------------------------------------------------------------------------------------------------+
+    |     FLUSHDB       |    No      | FLUSHDB                                                                                                             |
+    +-------------------+------------+---------------------------------------------------------------------------------------------------------------------+
+    |      INFO         |    No      | INFO                                                                                                                |
+    +-------------------+------------+---------------------------------------------------------------------------------------------------------------------+
+    |     LASTSAVE      |    No      | LASTSAVE                                                                                                            |
+    +-------------------+------------+---------------------------------------------------------------------------------------------------------------------+
+    |     MONITOR       |    No      | MONITOR                                                                                                             |
+    +-------------------+------------+---------------------------------------------------------------------------------------------------------------------+
+    |      SAVE         |    No      | SAVE                                                                                                                |
+    +-------------------+------------+---------------------------------------------------------------------------------------------------------------------+
+    |     SHUTDOWN      |    No      | SHUTDOWN [NOSAVE] [SAVE]                                                                                            |
+    +-------------------+------------+---------------------------------------------------------------------------------------------------------------------+
+    |     SLAVEOF       |    No      | SLAVEOF host port                                                                                                   |
+    +-------------------+------------+---------------------------------------------------------------------------------------------------------------------+
+    |     SLOWLOG       |    No      | SLOWLOG subcommand [argument]                                                                                       |
+    +-------------------+------------+---------------------------------------------------------------------------------------------------------------------+
+    |      SYNC         |    No      | SYNC                                                                                                                |
+    +-------------------+------------+---------------------------------------------------------------------------------------------------------------------+
+    |      TIME         |    No      | TIME                                                                                                                |
+    +-------------------+------------+---------------------------------------------------------------------------------------------------------------------+
+
+## Note
+
+- redis commands are not case sensitive
+- only vectored commands 'MGET key [key ...]' and 'DEL key [key ...]' needs to be fragmented
+
+## Performance
+
+### Setup
+
++ redis-server running on machine A.
++ nutcracker running on machine A as a local proxy to redis-server.
++ redis-benchmark running on machine B.
++ machine A != machine B.
++ nutcracker built with --enable-debug=no
++ nutcracker running with mbuf-size of 512 (-m 512)
++ redis-server built from redis 2.6 branch
+
+### redis-benchmark against redis-server
+
+    $ redis-benchmark -h <machine-A> -q -t set,get,incr,lpush,lpop,sadd,spop,lpush,lrange -c 100 -p 6379 
+    SET: 89285.71 requests per second
+    GET: 92592.59 requests per second
+    INCR: 89285.71 requests per second
+    LPUSH: 90090.09 requests per second
+    LPOP: 90090.09 requests per second
+    SADD: 90090.09 requests per second
+    SPOP: 93457.95 requests per second
+    LPUSH (needed to benchmark LRANGE): 89285.71 requests per second
+    LRANGE_100 (first 100 elements): 36496.35 requests per second
+    LRANGE_300 (first 300 elements): 15748.03 requests per second
+    LRANGE_500 (first 450 elements): 11135.86 requests per second
+    LRANGE_600 (first 600 elements): 8650.52 requests per second
+
+### redis-benchmark against nutcracker proxing redis-server
+
+    $ redis-benchmark -h <machine-A> -q -t set,get,incr,lpush,lpop,sadd,spop,lpush,lrange -c 100 -p 22121
+    SET: 85470.09 requests per second
+    GET: 86956.52 requests per second
+    INCR: 85470.09 requests per second
+    LPUSH: 84745.77 requests per second
+    LPOP: 86206.90 requests per second
+    SADD: 84745.77 requests per second
+    SPOP: 86956.52 requests per second
+    LPUSH (needed to benchmark LRANGE): 84745.77 requests per second
+    LRANGE_100 (first 100 elements): 29761.90 requests per second
+    LRANGE_300 (first 300 elements): 12376.24 requests per second
+    LRANGE_500 (first 450 elements): 8605.85 requests per second
+    LRANGE_600 (first 600 elements): 6587.62 requests per second
+