Metaphore
A PHP library that prevents cache stampedes using a semaphore to protect backend systems from dogpile effects.
What is Metaphore?
Metaphore is a PHP library designed to defend against cache stampedes, also known as the dogpile effect, which occurs when multiple requests simultaneously attempt to regenerate expired cache content, overwhelming backend resources like databases. It uses a semaphore-based locking mechanism to ensure only one request regenerates the cache while others serve stale content, maintaining performance and stability.
PHP developers building high-traffic web applications that rely on caching (e.g., using Memcached or Redis) and need to prevent database overload during cache expiration events.
Developers choose Metaphore for its simple, reliable semaphore-based approach to cache slam defense, which includes configurable TTL control, separate store management for values and locks, and event handling for edge cases like no stale cache scenarios.
Overview
Cache slam defense using a semaphore to prevent dogpile effect.
Use Cases
Best For
- Preventing database slams when cache expires simultaneously for many users on high-traffic PHP sites.
- Implementing stale-while-revalidate caching patterns in PHP applications to serve stale content gracefully during cache regeneration.
- Managing cache locks and values in different backends, such as using MySQL for locks and Memcached for cache values.
- Adding custom logging or result modification when no stale cache is available via event hooks.
- Configuring advanced cache TTL settings with grace periods and lock durations for fine-tuned control.
- Defending against the Slashdot effect or dogpile effect in PHP-based content management systems or APIs.
Not Ideal For
- Applications requiring zero stale content serving during cache regeneration, as Metaphore always serves stale cache to concurrent requests.
- Projects using non-PHP backend languages or polyglot microservices, since Metaphore is PHP-specific.
- Environments where built-in distributed lock support across data centers is needed, as Metaphore relies on external stores like MySQL or Memcached for locks.
- Teams wanting out-of-the-box integration with modern PHP frameworks without additional configuration work.
Pros & Cons
Pros
Prevents concurrent cache regeneration by allowing only one request to generate new content at a time, directly addressing the dogpile effect as described in the README's problem-solution overview.
Serves stale cached content to subsequent requests while new content is generated, similar to HTTP's stale-while-revalidate, ensuring performance and stability under high load.
Offers advanced TTL settings with grace periods and lock durations via the Ttl object, allowing fine-tuned control over cache behavior, as shown in the usage examples.
Enables cache values and locks to be stored in different backends, such as Memcached for values and MySQL for locks, increasing flexibility for complex deployments.
Cons
Requires setting up and maintaining external cache stores like Memcached or Redis, adding infrastructure complexity and potential points of failure.
Limited to PHP applications, making it unsuitable for projects using other languages or requiring cross-platform cache coordination.
The default lock TTL of 5 seconds might be too short for long-running cache generation tasks, risking multiple regenerations if not manually adjusted.
Frequently Asked Questions
Related Projects
Doctrine CacheDoctrine Cache component
CacheToolCLI App and library to manage apc & opcache.
StashThe place to keep your cache.
LockPopular PHP library for serialized execution of critical code in concurrent situations
Found a gem we're missing?
Open-Awesome is built by the community, for the community. Submit a project, suggest an awesome list, or help improve the catalog on GitHub.