Skip to content

Commit

Permalink
feat(cache) per object ttl for cache items. This adds TTL capibilites…
Browse files Browse the repository at this point in the history 
… to our CaffineCache and really deprecates the timed cache provider.

ref:#30670
  • Loading branch information
@wezell
wezell committed Nov 20, 2024
1 parent 4651454 commit cf419c4
Show file tree
Hide file tree
Showing 3 changed files with 29 additions and 259 deletions.
8 changes: 5 additions & 3 deletions dotCMS/src/main/java/com/dotmarketing/business/cache/provider/CacheStats.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -27,12 +27,14 @@ public class CacheStats {

public CacheStats(){}

public void addStat(String statName, String value) {
public CacheStats addStat(String statName, String value) {
stats.put(statName, value);
return this;
}

public void addStat(String statName, long value) {
public CacheStats addStat(String statName, long value) {
stats.put(statName, value+"");
return this;
}

public Set<String> getStatColumns() {
Expand All @@ -45,4 +47,4 @@ public String getStatValue(String columnName) {



}
}
37 changes: 22 additions & 15 deletions dotCMS/src/main/java/com/dotmarketing/business/cache/provider/caffine/CaffineCache.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -119,7 +119,7 @@ public void remove(String group) {

@Override
public void removeAll() {
this.init();
groups.invalidateAll();
}

@Override
Expand Down Expand Up @@ -180,15 +180,15 @@ public CacheProviderStats getStats() {
String duration = millis == Long.MAX_VALUE ? "" : " | ttl:" + nf.format(millis / 1000) + "s";

com.github.benmanes.caffeine.cache.stats.CacheStats cstats = foundCache.stats();
stats.addStat(CacheStats.REGION, group);
stats.addStat(CacheStats.REGION_DEFAULT, "false");
stats.addStat(CacheStats.REGION_CONFIGURED_SIZE, "size:" + nf.format(size) + duration );
stats.addStat(CacheStats.REGION_SIZE, nf.format(foundCache.estimatedSize()));
stats.addStat(CacheStats.REGION_LOAD, nf.format(cstats.missCount() + cstats.hitCount()));
stats.addStat(CacheStats.REGION_HITS, nf.format(cstats.hitCount()));
stats.addStat(CacheStats.REGION_HIT_RATE, pf.format(cstats.hitRate()));
stats.addStat(CacheStats.REGION_AVG_LOAD_TIME, nf.format(cstats.averageLoadPenalty() / 1000000) + " ms");
stats.addStat(CacheStats.REGION_EVICTIONS, nf.format(cstats.evictionCount()));
stats.addStat(CacheStats.REGION, group)
.addStat(CacheStats.REGION_DEFAULT, "false")
.addStat(CacheStats.REGION_CONFIGURED_SIZE, "size:" + nf.format(size) + duration )
.addStat(CacheStats.REGION_SIZE, nf.format(foundCache.estimatedSize()))
.addStat(CacheStats.REGION_LOAD, nf.format(cstats.missCount() + cstats.hitCount()))
.addStat(CacheStats.REGION_HITS, nf.format(cstats.hitCount()))
.addStat(CacheStats.REGION_HIT_RATE, pf.format(cstats.hitRate()))
.addStat(CacheStats.REGION_AVG_LOAD_TIME, nf.format(cstats.averageLoadPenalty() / 1000000) + " ms")
.addStat(CacheStats.REGION_EVICTIONS, nf.format(cstats.evictionCount()));
ret.addStatRecord(stats);
}

Expand All @@ -214,11 +214,18 @@ private DynamicTTLCache<String, Object> getCache(String cacheName) {
throw new DotStateException("Null cache region passed in");
}

return groups.get(cacheName, k -> {
final int maxSize = getMaxSize(cacheName);
final long ttlSeconds = getTTLMillis(cacheName);
return new DynamicTTLCache<>(maxSize, ttlSeconds);
});
DynamicTTLCache<String, Object> cache = groups.getIfPresent(cacheName);
if(cache != null){
return cache;
}
final int maxSize = getMaxSize(cacheName);
final long ttlSeconds = getTTLMillis(cacheName);
synchronized (groups) {
return groups.get(cacheName, k ->

new DynamicTTLCache<>(maxSize, ttlSeconds)
);
}



Expand Down
243 changes: 2 additions & 241 deletions ...src/main/java/com/dotmarketing/business/cache/provider/timedcache/TimedCacheProvider.java
View file
Original file line number Diff line number Diff line change
@@ -1,22 +1,6 @@
package com.dotmarketing.business.cache.provider.timedcache;

import java.text.DecimalFormat;
import java.text.NumberFormat;
import java.util.HashSet;
import java.util.Iterator;
import java.util.Set;
import java.util.concurrent.ConcurrentHashMap;
import java.util.concurrent.TimeUnit;

import com.dotcms.enterprise.cache.provider.CacheProviderAPI;
import com.dotmarketing.business.DotStateException;
import com.dotmarketing.business.cache.provider.CacheProvider;
import com.dotmarketing.business.cache.provider.CacheProviderStats;
import com.dotmarketing.business.cache.provider.CacheStats;
import com.dotmarketing.util.Config;
import com.dotmarketing.util.Logger;
import com.github.benmanes.caffeine.cache.Cache;
import com.github.benmanes.caffeine.cache.Caffeine;
import com.dotmarketing.business.cache.provider.caffine.CaffineCache;
/**
* Provides a timed cache implementation using Caffeine.
* @deprecated
Expand All @@ -25,22 +9,11 @@
* <p> Use {@link com.dotmarketing.business.cache.provider.caffine.CaffineCache} instead.
*/
@Deprecated(since = "24.12", forRemoval = false)
public class TimedCacheProvider extends CacheProvider {
public class TimedCacheProvider extends CaffineCache {


private static final long serialVersionUID = 1L;

private Boolean isInitialized = false;

private final ConcurrentHashMap<String, Cache<String, Object>> groups = new ConcurrentHashMap<>();

static final String DEFAULT_CACHE = CacheProviderAPI.DEFAULT_CACHE;


private final HashSet<String> availableCaches = new HashSet<>();

private final int DEFAULT_TIMEOUT = 100;

@Override
public String getName() {
return "Timed Cache Provider";
Expand All @@ -51,219 +24,7 @@ public String getKey() {
return "Timed Cache Provider";
}

@Override
public boolean isDistributed() {
return false;
}

@Override
public void init() {
groups.clear();
Logger.info(this.getClass(), "===== Initializing [" + getName() + "].");
availableCaches.add(DEFAULT_CACHE);
Iterator<String> it = Config.getKeys();
while (it.hasNext()) {
String key = it.next();
if (key == null) {
continue;
}
if (key.startsWith("cache.")) {
String cacheName = key.split("\\.")[1];
if (key.endsWith(".size")) {
int inMemory = Config.getIntProperty(key, 0);
availableCaches.add(cacheName.toLowerCase());
Logger.info(this.getClass(), "***\t Cache Config Memory : "
+ cacheName + ": " + inMemory);
}
}
}

isInitialized = true;
}

@Override
public boolean isInitialized () throws Exception {
return isInitialized;
}

@Override
public void put(String group, String key, Object content) {
if (group == null || key == null || content == null) {
return;
}
Cache<String, Object> cache = getCache(group);
cache.put(key, content);
}

@Override
public Object get(String group, String key) {
// Get the cache for the given group
Cache cache = getCache(group);
return cache.getIfPresent(key);

}

@Override
public void remove(String group, String key) {

Cache<String, Object> cache = getCache(group);
// Invalidates from Cache a key from a given group
cache.invalidate(key);
}

@Override
public void remove(String group) {
Logger.debug(this.getClass(), "===== Calling remove for [" + getName()
+ "] - " + cacheKey(group, ""));
// Get the cache for the given group
Cache<String, Object> cache = getCache(group);
// Invalidates the Cache for the given group
cache.invalidateAll();
// Remove this group from the global list of cache groups
groups.remove(group);
}

@Override
public void removeAll() {
this.init();
}

@Override
public Set<String> getKeys(String group) {
Cache<String, Object> cache = getCache(group);
return cache.asMap().keySet();
}

@Override
public Set<String> getGroups() {
return groups.keySet();
}

@Override
public CacheProviderStats getStats() {

CacheStats providerStats = new CacheStats();
CacheProviderStats ret = new CacheProviderStats(providerStats,getName());

Set<String> currentGroups = new HashSet<>();
currentGroups.addAll(getGroups());

NumberFormat nf = DecimalFormat.getInstance();
DecimalFormat pf = new DecimalFormat("##.##%");
for (String group : currentGroups) {
CacheStats stats = new CacheStats();

Cache<String, Object> foundCache = getCache(group);


boolean isDefault = (Config.getIntProperty("cache." + group + ".size", -1) == -1 && Config.getIntProperty("cache." + group + ".seconds", -1) == -1);


int size = isDefault ? Config.getIntProperty("cache." + DEFAULT_CACHE + ".size", 100)
: (Config.getIntProperty("cache." + group + ".size", -1) != -1)
? Config.getIntProperty("cache." + group + ".size")
: Config.getIntProperty("cache." + DEFAULT_CACHE + ".size", 100);

int seconds = isDefault ? Config.getIntProperty("cache." + DEFAULT_CACHE + ".seconds", 100)
: (Config.getIntProperty("cache." + group + ".seconds", -1) != -1)
? Config.getIntProperty("cache." + group + ".seconds")
: Config.getIntProperty("cache." + DEFAULT_CACHE + ".seconds", 100);



com.github.benmanes.caffeine.cache.stats.CacheStats cstats = foundCache.stats();
stats.addStat(CacheStats.REGION, group);
stats.addStat(CacheStats.REGION_DEFAULT, isDefault + "");
stats.addStat(CacheStats.REGION_CONFIGURED_SIZE, "size:" + nf.format(size) + " / " + seconds + "s");
stats.addStat(CacheStats.REGION_SIZE, nf.format(foundCache.estimatedSize()));
stats.addStat(CacheStats.REGION_LOAD, nf.format(cstats.missCount()+cstats.hitCount()));
stats.addStat(CacheStats.REGION_HITS, nf.format(cstats.hitCount()));
stats.addStat(CacheStats.REGION_HIT_RATE, pf.format(cstats.hitRate()));
stats.addStat(CacheStats.REGION_AVG_LOAD_TIME, nf.format(cstats.averageLoadPenalty()/1000000) + " ms");
stats.addStat(CacheStats.REGION_EVICTIONS, nf.format(cstats.evictionCount()));


ret.addStatRecord(stats);
}

if(currentGroups.isEmpty()) {
CacheStats stats = new CacheStats();
stats.addStat(CacheStats.REGION, "n/a");
stats.addStat(CacheStats.REGION_SIZE, 0);
ret.addStatRecord(stats);
}

return ret;
}

@Override
public void shutdown() {
Logger.info(this.getClass(), "===== Calling shutdown [" + getName()+ "].");
isInitialized = false;
}

private String cacheKey(String group, String key) {
return (group + ":" + key).toLowerCase();
}

private Cache<String, Object> getCache(String cacheName) {
if (cacheName == null) {
throw new DotStateException("Null cache region passed in");
}
cacheName = cacheName.toLowerCase();
Cache<String, Object> cache = groups.get(cacheName);
// init cache if it does not exist
if (cache == null) {
synchronized (cacheName.intern()) {
cache = groups.get(cacheName);
// init cache if it does not exist
if (cache == null) {
synchronized (cacheName.intern()) {
cache = groups.get(cacheName);
if (cache == null) {

boolean separateCache = (Config.getBooleanProperty(
"cache.separate.caches.for.non.defined.regions", true)
|| availableCaches.contains(cacheName)
|| DEFAULT_CACHE.equals(cacheName));

if (separateCache) {
int size = Config.getIntProperty("cache." + cacheName + ".size", -1);
int seconds = Config.getIntProperty("cache." + cacheName + ".seconds", -1);
if (size == -1) {
size = Config.getIntProperty("cache." + DEFAULT_CACHE + ".size", 100);
}
if (seconds == -1) {
seconds = Config.getIntProperty("cache." + DEFAULT_CACHE + ".seconds", 100);
}
Logger.infoEvery(this.getClass(),
"***\t Building Cache : " + cacheName + ", size:" + size + ", seconds:" + seconds
+ ",Concurrency:"
+ Config.getIntProperty("cache.concurrencylevel", 32), 60000);
cache = Caffeine.newBuilder()
.maximumSize(size)
.expireAfterWrite(seconds, TimeUnit.SECONDS)
.recordStats()
//.softValues()
.build();


groups.put(cacheName, cache);

} else {
Logger.infoEvery(this.getClass(),
"***\t No Cache for : " + cacheName + ", using " + DEFAULT_CACHE, 60000);
cache = getCache(DEFAULT_CACHE);
groups.put(cacheName, cache);
}
}
}
}

}
}
return cache;
}



Expand Down

0 comments on commit cf419c4

Please sign in to comment.