Skip to main content

Redis/nutcracker client for Turnstile

Project description

The NutJob client is an alternate Redis client based on redis.StrictRedis. It is meant for use with Turnstile, in conjunction with the Redis proxy nutcracker, aka twemproxy. Certain functionality which is unsupported by nutcracker is overridden in NutJob, either to disable it (such as Turnstile’s PUBLISH to report errors) or to replace it with equivalent functionality (such as the register_script() call used by the Turnstile compactor daemon).

NutJob is really only intended for use with Turnstile; it is not meant as a general-purpose Redis/nutcracker client.

How to Use

To use NutJob, add the following configuration settings to the appropriate sections of your Turnstile configuration:

[redis]
redis_client = nutjob
server_version = <see text>
host = <nutcracker IP>

[control]
redis_client = redis
server_version =
host = <Redis server IP>

Note the overrides in the [control] section, particularly the explicitly empty value of server_version: the Turnstile control daemon MUST be configured to use the standard Redis client and to connect to an actual Redis server; the control daemon relies on functionality that nutcracker does not support.

As for the server_version value in the [redis] section: this value is optional, but if set, it should be the minimum server version of the Redis servers connected behind the nutcracker proxy. This information is used by the Turnstile compactor daemon to enable an optimization; normally, the compactor daemon determines whether to use this optimization based on the server version reported by the Redis server itself, but nutcracker does not support this version retrieval, and so NutJob provides this server_version side channel to allow its use.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

nutjob-0.1.0.tar.gz (8.4 kB view details)

Uploaded Source

File details

Details for the file nutjob-0.1.0.tar.gz.

File metadata

  • Download URL: nutjob-0.1.0.tar.gz
  • Upload date:
  • Size: 8.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for nutjob-0.1.0.tar.gz
Algorithm Hash digest
SHA256 b11664b77cea4272f06c618f9d3bfb0b4f73d6952ae82256e7dc6ae29ea1f037
MD5 4119eab466a37f6b07dae3d876702d0d
BLAKE2b-256 29df0e9c416268755d5ca47d35851412a54db16294cc17ee3a392a5f37eb7894

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page