Child pages
  • Terracotta Distributed Cache
Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 25 Next »

About Terracotta Documentation

This documentation is about Terracotta DSO, an advanced distributed-computing technology aimed at meeting special clustering requirements.

Terracotta products without the overhead and complexity of DSO meet the needs of almost all use cases and clustering requirements. To learn how to migrate from Terracotta DSO to standard Terracotta products, see Migrating From Terracotta DSO. To find documentation on non-DSO (standard) Terracotta products, see Terracotta Documentation. Terracotta release information, such as release notes and platform compatibility, is found in Product Information.

Unknown macro: {div9}
Release: 3.6
Publish Date: November, 2011

Documentation Archive »

Terracotta Cache Evictor

Introduction

The Terracotta cache evictor is an interface providing a simple distributed eviction solution for map elements. The cache evictor, implemented with the Terracotta Integration Module tim-map-evictor, provides a number of advantages over more complex solutions:

  • Simple: API is easy to understand and code against.
  • Standard: Data eviction is based on standard expiration metrics.
  • Lightweight: Implementation does not hog resources.
  • Efficient: Optimized for a clustered environment to minimize faulting due to low locality of reference.
  • Fail-safe: Data can be evicted even if written by a failed node or after all nodes have been restarted.
  • Native: Designed for Terracotta to eliminate integration issues.

Requirements

The Terracotta distributed data cache requires JDK 1.5 or greater.

Characteristics

Notable characteristics include:

  • A cache-wide Time To Live (TTL) value can be set. The TTL determines the maximum amount of time an object can remain in the cache before becoming eligible for eviction, regardless of other conditions such as use.
  • A cache-wide Time To Idle (TTI) value can be set. The TTI determines the maximum amount of time an object can remain idle in the cache before becoming eligible for eviction. TTI is reset each time the object is used.
  • Each cache element receives an internal timestamp used against the cache-wide TTL and TTI.

Terracotta Cache Evictor in a Reference Application

The [Examinator reference application] uses the Terracotta cache evictor to handle pending user registrations. This type of data has a "medium-term" lifetime which needs to be persisted long enough to give prospective registrants a chance to verify their registrations. If a registration isn't verified by the time TTL is reached, it can be evicted from the cache. Only if the registration is verified is it written to the database.

The combination of Terracotta and the Terracotta cache evictor gives Examinator the following advantages:

  • The simple Terracotta cache evictor's API makes it easy to integrate with Examinator and to maintain and troubleshoot.
  • Medium-term data is not written to the database unnecessarily, improving application performance.
  • Terracotta persists the pending registrations so they can survive node failure.
  • Terracotta clusters (shares) the pending registration data so that any node can handle validation.

A Simple Cache with Terracotta Cache Evictor

Clustered applications with a system of record (SOR) on the backend can benefit from a distributed cache that manages certain data in memory while reducing costly application-SOR interactions. However, using a cache can introduce increased complexity to software development, integration, operation, and maintenance.

The Terracotta cache evictor includes a distributed-map that can be used as a simple distributed cache. This cache uses the Terracotta cache evictor, incorporating all of its benefits. It also takes both established and innovative approaches to the caching model, solving performance and complexity issues by:

  • obviate SOR commits for data with a limited lifetime;
  • making cached application data available in-memory across a cluster of application servers;
  • offering standard methods for working with cache elements and performing cache-wide operations;
  • incorporating concurrency for readers and writers;
  • utilizing a flexible map implementation to adapt to more applications;
  • minimizing inter-node faulting to speed data operations.

Structure and Characteristics

The Terracotta distributed cache is an interface incorporating a distributed map with standard map operations:

public interface DistributedMap<K, V> {
  // Single item operations
  void put(K key, V value);
  V get(K key);
  V remove(K key);
  boolean containsKey(K key);

  // Multi item operations
  int size();
  void clear();
  Set<K> getKeys();

  // For managing the background evictor thread
  void start();
  void shutdown();
}

getValues() is not provided, but an iterator can be obtained for Set<K> to obtain values.

Usage Pattern

A typical usage pattern for the Terracotta cache evictor is shown in the MyStuff class below. The next section contains a full list of configuration parameters available to DistributedMapBuilder.

import org.terracotta.modules.dmap.DistributedMap;
import org.terracotta.modules.dmap.DistributedMapBuilder;
import static org.terracotta.modules.dmap.DistributedMapBuilder.HOUR;
import static org.terracotta.modules.dmap.DistributedMapBuilder.MINUTE;

public class MyStuff {

   // Mark as Terracotta root
   private DistributedMap<String, Stuff> sharedMap;

   public MyStuff() {
     if(sharedMap == null) {
       DistributedMap<String,Stuff> newMap = new DistributedMapBuilder() 
            .setMaxTTLMillis(6*HOUR)                                            // regardless of use, remove after 6 hours
           .setMaxTTIMillis(30*MINUTE)                                  // remove after 30 minutes of unuse
           .setEvictorSleepMillis(5*MINUTE)                             // only do eviction every 5 minutes
           .newMap();

       // set root - if this doesn't succeed, shutdown the newMap as it has a worthless background evictor thread
       sharedMap = newMap;
       if(sharedMap != newMap) {
         newMap.shutdown();
       }
   }

   public void putStuff(String key, Stuff stuff) {
       sharedMap.put(key, stuff);
   }

   public Stuff getStuff(String key) {
       return sharedMap.get(key);
   }
}

Evictor Configuration Parameters

Config property

Default value

Description

name

"Distributed Map"

A descriptive string used in log messages and evictor thread names

concurrency

16

The concurrency, or maximum number of accessors allowed at one time, in the map implementation

maxTTIMillis

0

Time To Idle - the maximum amount of time (in milliseconds) an item can be in the map unused before expiration; 0 means never expire due to TTI

maxTTLMillis

0

Time To Live - the maximum amount of time (in milliseconds) an item may be in the map regardless of use before expiration; 0 means never expire due to TTL

evictorSleepMillis

30000

Wait time (in milliseconds) between eviction cycles. You should adjust this to be appropriate to your TTI/TTL values.

orphanEvictionEnabled

true

Determines whether "orphaned" values no longer local to any node are evicted

orphanEvictionFrequency

4

  1. of times to run local eviction between doing orphan eviction

orphanBatchSize

1000

size of each set of items evicted during orphan eviction

orphanBatchPauseMillis

20

rest time between each orphan eviction batch

loggingEnabled

false

Basic distributed map logging

evictorLoggingEnabled

false

Eviction logging

Usage Example

The following is an example of a cache that implements the Terracotta distributed cache:

import org.terracotta.modules.dmap.*;
import static org.terracotta.modules.dmap.DistributedMapBuilder.*;


DisributedMap<String,String> map = new DistributedMapBuilder()
.setMaxTTLMillis(10 * SECOND)
.setMaxTTIMillis(5 * SECOND)
.setConcurrency(16)
.newMap();
map.start(); // start eviction thread


map.put("Rabbit", "Carrots");
map.put("Dog", "Bone");
map.put("Owl", "Mouse");
// wait 3 seconds
map.get("Rabbit");


// wait 2 seconds - expire Dog and Owl due to TTI
assert ! map.containsKey("Dog");
assert ! map.containsKey("Owl");
assert map.containsKey("Rabbit");


// wait 5 seconds - expire Rabbit due to TTL
assert ! map.containsKey("Rabbit");
  • No labels