This page contains information about Memcached as used for MediaWiki's object cache.
MediaWiki's Memcached cluster runs on mc10XX hosts (in eqiad) and mc20XX hosts (in codfw).
WANObjectCache is the higher-level abstraction layer in MediaWiki PHP that deals with multi-datacenter concerns and Mcrouter. It builds on top of BagOStuff which is generic key-value class used to abstract the Memcached protocol itself.
- WANObjectCache high-level documentation
- WANObjectCache metrics and internal details
- mw:Manual:Caching, documentation of what kind of data is stored, what the keys relate to etc.
- Like a replica. Historically, it was common for MediaWiki to populate its cache during HTTP write actions. This meant that in a single DC setup it could loosely be expected that the cache was as up-to-date as the master DB. As part of the multi-dc effort, this was changed starting in 2015. There is now generally no proactive setting of values during HTTP write actions. Instead, values are generally computed based on information from replica DBs, and computed on-demand using the
getWithSet(key, ttl, callable)idiom. This means the application generally only expects cache values to be as up to date as a replica DB would be.
- No synchronisation. MediaWiki's WANObjectCache layer does not require synchronisation of cached values cross data centers. Instead, it considers each datacenter's Memcached cluster as independent. Each populating its own values as-needed on dc-local app servers from dc-local replica DBs.
- Tombstones (broadcasted purge) During HTTP write actions, MediaWiki asks WANObjectCache to purge cache keys of which it has modified the source data. These purges take the form of a short-lived Memcached key known as a "tombstone". We do not use the DELETE command because we want each data center to be able to populate its memcached independent, thus requiring no cross-dc master database connection, thus reading from a local replica, thus values ingested in the cache may be as stale as a replica can be. Implementing a Memcached purge as DELETE would mean both in the same DC and other DCs, the same key could be re-populated immediately with the same stale value we just deleted. Instead, WANObjectCache formulates its purge as a SET operation that stores a placeholder value known as a "tombstone" (lasts for approx. 10 seconds).
- Interim values Upon seeing such tombstone, WANObjectCache acts much like a cache miss, except that the newly computed value is not written back over the tombstone (as it may be stale). Instead, to avoid a recompute stampede these maybe-stale values are stored as an "interim value" in a sister key.
- Read traffic from the
getWithSetidiom results in a
GETScommand (getMulti) that fetches the main key, plus any sister keys that might exist.
- Write trafffic from the
getWithSetidiom results in either
ADDif the key was known to be absent, or
Memcached->mergeViaCasif a value existed but either required (or was elected for) regeneration.
- Purge traffic uses the
/*/mw-wan/prefix to tell Mcouter to broadcast this to other pools and clusters as well. The actual command is generally
SETas it needs to induce a "hold-off" period using the tombstone (per the above). In rare cases where a hold-off is not needed (e.g. if the purge is not related to a DB write), then the broadcasted event will use
- Last updated: May 2020.
- Tombstone (aka hold-off TTL): 11 seconds
- Interim value: 1 second
- Main article: Memcached/mcrouter
Each MediaWiki api/appserver sees memcached through a local proxy called Mcrouter. This daemon is configured with all the mc[1,2]0XX hosts as shards, and applies consistent hashing on the key name to know where to store it. The following example should help clarifying how things flow on this layer.
The MediaWiki translate extension stores the key WANCache:v:metawiki:translate-groups in memcached, using the WANObjectCache as library. For example, a GET command to retrieve the key's value is sent from MediaWiki to localhost:11213, where mcrouter is listening, and the command gets routed to mc1022. MediaWiki it totally ignorant about the mc[1,2]0XX host, it only knows about sending commands to a localhost port. A mcrouter admin command helps figure out where the key gets routed:
elukey@mw1345:~$ echo "get __mcrouter__.route(get,WANCache:v:metawiki:translate-groups)" | nc localhost 11213 -q 2 VALUE __mcrouter__.route(get,WANCache:v:metawiki:translate-groups) 0 16 10.64.0.83:11211 END elukey@mw1345:~$ dig -x 10.64.0.83 +short mc1022.eqiad.wmnet.
Some things to notice:
- The special prefix __mcrouter__.route is interpreted by mcrouter as admin command, that in this case returns the proxy target of the consistent hashing of the key name.
- mcrouter listen on port 11213 on every MediaWiki hosts, meanwhile on every mc10XX host memcached listens on 11211.
To get a key and dump it to a file it is sufficient to:
elukey@mw1345:~$ echo "get WANCache:v:metawiki:translate-groups" | nc localhost 11213 -q 2 > dump.txt elukey@mw1345:~$ du -hs dump.txt 380K dump.txt
In this case the key's value is pretty big, and it needs PHP to be interpreted correctly (to unserialize it), but nonetheless we got some useful information (like the size of the key). This could be useful when it is necessary to quickly get how big a key is, rather than knowing its content.