NUTCRACKER(8)

💖 NUTCRACKER 💖

okay bestie, welcome to the NUTCRACKER(8) page — yeah it lives in the System Manager's Manual, and yeah it's about to become your new obsession. this is nutcracker. grab a strawberry 🍓 and sit with me.

✨ NAME ✨

nutcracker — a fast, light-weight proxy for memcached and Redis. literally the main character of caching infrastructure. 💅

✨ SYNOPSIS ✨

nutcracker [options]

that's it. that's the whole summoning ritual. 🎀

✨ DESCRIPTION ✨

so nutcracker — also known as twemproxy (pronounced "two-em-proxy", yes say it out loud, it's giving nickname energy) — is a fast and lightweight proxy for the memcached and Redis protocols. 🦋

it was primarily built to reduce the connection count on backend caching servers, but it has a whole personality of features, such as:

• Maintains persistent server connections to backend servers. no cap, the connections stay up. 🔥
• Enables pipelining of requests and responses. everything flows. ✨
• Supports multiple server pools simultaneously. polyamorous server management, honestly. 💜
• Shard data automatically across multiple servers. it just does the math for you, king behavior. 👑
• Supports multiple hashing modes including consistent hashing and distribution. options on options. 🌈
• High-availability by disabling nodes on failures. if a server acts up, it gets benched. 💀
• Observability through stats exposed on stats monitoring port. it's not nosy, it's transparent. 🌸

✨ OPTIONS ✨

every flag, every default, all of it. don't skip. i see you. 🙈

• -h, --help — Show usage information and exit. the "help me bestie" button. 🫶
• -V, --version — Show version and exit. just a lil flex. ⭐
• -t, --test-conf — Test configuration for syntax errors and exit. vibe check your config before you commit to anything. 💅
• -D, --describe-stats — Print stats description and exit. tell me about yourself, stats edition. 📊
• -v, --verbose=N — Set logging level to N. (default: 5, min: 0, max: 11) — yes the max is eleven. it goes to eleven. 🔥
• -o, --output=filename — Set logging file to filename. where the receipts go. 🧾
• -c, --conf-file=filename — Set configuration file to filename. this is the one that matters most, ngl. 🎀
• -s, --stats-port=port — Set stats monitoring port to port. (default: 22222) — five twos, iconic. ✨
• -a, --stats-addr=address — Set stats monitoring IP to address. (default: 0.0.0.0) — listen on everything, apparently. 🌈
• -i, --stats-interval=interval — Set stats aggregation interval in msec to interval. (default: 30000 msec) — that's 30 seconds of tea being gathered. 🍓
• -m, --mbuf-size=size — Set size of mbuf chunk in bytes to size. (default: 16384 bytes) — buffers gotta be buff. 💪
• -d, --daemonize — Run as a daemon. it's not leaving, it lives here now. 🦋
• -p, --pid-file=filename — Set pid file to filename. so you can find it later, iykyk. 🔍

✨ SEE ALSO ✨

• memcached(8)
• redis-server(1)

go say hi to the neighbors. 👋

✨ AUTHOR ✨

nutcracker was written by Twitter, Inc. — periodt. 👑

okay that's the whole page!! this one was dated June 13, 2013 and it's part of the System Manager's Manual, filed under NUTCRACKER(8). stay cached, stay slaying 💖✨🎀