YARN-11471. [Federation] FederationStateStoreFacade Cache Support Caffeine. (#6795) Contributed by Shilun Fan.
Reviewed-by: Inigo Goiri <inigoiri@apache.org> Signed-off-by: Shilun Fan <slfan1989@apache.org>
This commit is contained in:
slfan1989
GitHub
parent
d8b485a512
commit
9f6c997662
@ -226,6 +226,7 @@ com.fasterxml.jackson.jaxrs:jackson-jaxrs-json-provider:2.12.7
|
||||
com.fasterxml.jackson.module:jackson-module-jaxb-annotations:2.12.7
|
||||
com.fasterxml.uuid:java-uuid-generator:3.1.4
|
||||
com.fasterxml.woodstox:woodstox-core:5.4.0
|
||||
com.github.ben-manes.caffeine:caffeine:2.9.3
|
||||
com.github.davidmoten:rxjava-extras:0.8.0.17
|
||||
com.github.stephenc.jcip:jcip-annotations:1.0-1
|
||||
com.google:guice:4.0
|
||||
|
||||
@ -134,6 +134,7 @@
|
||||
<kerby.version>2.0.3</kerby.version>
|
||||
<ehcache.version>3.8.2</ehcache.version>
|
||||
<cache.api.version>1.1.1</cache.api.version>
|
||||
<caffeine.version>2.9.3</caffeine.version>
|
||||
<hikari.version>4.0.3</hikari.version>
|
||||
<derby.version>10.14.2.0</derby.version>
|
||||
<mssql.version>6.2.1.jre7</mssql.version>
|
||||
@ -1975,6 +1976,11 @@
|
||||
</exclusion>
|
||||
</exclusions>
|
||||
</dependency>
|
||||
<dependency>
|
||||
<groupId>com.github.ben-manes.caffeine</groupId>
|
||||
<artifactId>caffeine</artifactId>
|
||||
<version>${caffeine.version}</version>
|
||||
</dependency>
|
||||
<dependency>
|
||||
<groupId>com.zaxxer</groupId>
|
||||
<artifactId>HikariCP</artifactId>
|
||||
|
||||
@ -131,6 +131,20 @@
|
||||
<groupId>org.ehcache</groupId>
|
||||
<artifactId>ehcache</artifactId>
|
||||
</dependency>
|
||||
<dependency>
|
||||
<groupId>com.github.ben-manes.caffeine</groupId>
|
||||
<artifactId>caffeine</artifactId>
|
||||
<exclusions>
|
||||
<exclusion>
|
||||
<groupId>org.checkerframework</groupId>
|
||||
<artifactId>checker-qual</artifactId>
|
||||
</exclusion>
|
||||
<exclusion>
|
||||
<groupId>com.google.errorprone</groupId>
|
||||
<artifactId>error_prone_annotations</artifactId>
|
||||
</exclusion>
|
||||
</exclusions>
|
||||
</dependency>
|
||||
<dependency>
|
||||
<groupId>com.zaxxer</groupId>
|
||||
<artifactId>HikariCP</artifactId>
|
||||
|
||||
@ -0,0 +1,131 @@
|
||||
/**
|
||||
* Licensed to the Apache Software Foundation (ASF) under one or more
|
||||
* contributor license agreements. See the NOTICE file distributed with this
|
||||
* work for additional information regarding copyright ownership. The ASF
|
||||
* licenses this file to you under the Apache License, Version 2.0 (the
|
||||
* "License"); you may not use this file except in compliance with the License.
|
||||
* You may obtain a copy of the License at
|
||||
* <p>
|
||||
* http://www.apache.org/licenses/LICENSE-2.0
|
||||
* <p>
|
||||
* Unless required by applicable law or agreed to in writing, software
|
||||
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
|
||||
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
|
||||
* License for the specific language governing permissions and limitations under
|
||||
* the License.
|
||||
*/
|
||||
package org.apache.hadoop.yarn.server.federation.cache;
|
||||
|
||||
import com.github.benmanes.caffeine.cache.Cache;
|
||||
import com.github.benmanes.caffeine.cache.Caffeine;
|
||||
import org.apache.hadoop.conf.Configuration;
|
||||
import org.apache.hadoop.yarn.api.records.ApplicationId;
|
||||
import org.apache.hadoop.yarn.conf.YarnConfiguration;
|
||||
import org.apache.hadoop.yarn.exceptions.YarnException;
|
||||
import org.apache.hadoop.yarn.server.federation.store.FederationStateStore;
|
||||
import org.apache.hadoop.yarn.server.federation.store.records.SubClusterId;
|
||||
import org.apache.hadoop.yarn.server.federation.store.records.SubClusterInfo;
|
||||
import org.apache.hadoop.yarn.server.federation.store.records.SubClusterPolicyConfiguration;
|
||||
import org.slf4j.Logger;
|
||||
import org.slf4j.LoggerFactory;
|
||||
|
||||
import java.util.Map;
|
||||
import java.util.concurrent.TimeUnit;
|
||||
|
||||
/**
|
||||
* CaffeineCache is a high-performance caching library for Java, offering better performance compared to Ehcache and Guava Cache.
|
||||
* We are integrating this cache to store information about application and homesubclusters etc.
|
||||
*/
|
||||
public class FederationCaffeineCache extends FederationCache {
|
||||
|
||||
private static final Logger LOG = LoggerFactory.getLogger(FederationCaffeineCache.class);
|
||||
|
||||
private Cache<String, CacheRequest> cache;
|
||||
|
||||
private int cacheTimeToLive;
|
||||
private long cacheEntityNums;
|
||||
|
||||
private String className = this.getClass().getSimpleName();
|
||||
|
||||
private boolean isCachingEnabled = false;
|
||||
|
||||
@Override
|
||||
public boolean isCachingEnabled() {
|
||||
return isCachingEnabled;
|
||||
}
|
||||
|
||||
@Override
|
||||
public void initCache(Configuration pConf, FederationStateStore pStateStore) {
|
||||
cacheTimeToLive = pConf.getInt(YarnConfiguration.FEDERATION_CACHE_TIME_TO_LIVE_SECS,
|
||||
YarnConfiguration.DEFAULT_FEDERATION_CACHE_TIME_TO_LIVE_SECS);
|
||||
cacheEntityNums = pConf.getLong(YarnConfiguration.FEDERATION_CACHE_ENTITY_NUMS,
|
||||
YarnConfiguration.DEFAULT_FEDERATION_CACHE_ENTITY_NUMS);
|
||||
if (cacheTimeToLive <= 0) {
|
||||
isCachingEnabled = false;
|
||||
LOG.warn("Federation cache is not enabled. If we want to enable federation cache, " +
|
||||
"we need to set yarn.federation.cache-ttl.secs greater than 0.");
|
||||
return;
|
||||
}
|
||||
this.setStateStore(pStateStore);
|
||||
|
||||
// Initialize Cache.
|
||||
LOG.info("Creating a JCache Manager with name {}. " +
|
||||
"Cache TTL Time = {} secs. Cache Entity Nums = {}.", className, cacheTimeToLive,
|
||||
cacheEntityNums);
|
||||
|
||||
this.cache = Caffeine.newBuilder().maximumSize(cacheEntityNums)
|
||||
.expireAfterWrite(cacheTimeToLive, TimeUnit.SECONDS).build();
|
||||
}
|
||||
|
||||
@Override
|
||||
public void clearCache() {
|
||||
this.cache.cleanUp();
|
||||
this.cache = null;
|
||||
}
|
||||
|
||||
@Override
|
||||
public Map<SubClusterId, SubClusterInfo> getSubClusters(
|
||||
boolean filterInactiveSubClusters) throws YarnException {
|
||||
final String cacheKey = buildCacheKey(className, GET_SUBCLUSTERS_CACHEID,
|
||||
Boolean.toString(filterInactiveSubClusters));
|
||||
CacheRequest<String, ?> cacheRequest = cache.getIfPresent(cacheKey);
|
||||
if (cacheRequest == null) {
|
||||
cacheRequest = buildGetSubClustersCacheRequest(className, filterInactiveSubClusters);
|
||||
cache.put(cacheKey, cacheRequest);
|
||||
}
|
||||
return buildSubClusterInfoMap(cacheRequest);
|
||||
}
|
||||
|
||||
@Override
|
||||
public Map<String, SubClusterPolicyConfiguration> getPoliciesConfigurations()
|
||||
throws Exception {
|
||||
final String cacheKey = buildCacheKey(className, GET_POLICIES_CONFIGURATIONS_CACHEID);
|
||||
CacheRequest<String, ?> cacheRequest = cache.getIfPresent(cacheKey);
|
||||
if(cacheRequest == null){
|
||||
cacheRequest = buildGetPoliciesConfigurationsCacheRequest(className);
|
||||
cache.put(cacheKey, cacheRequest);
|
||||
}
|
||||
return buildPolicyConfigMap(cacheRequest);
|
||||
}
|
||||
|
||||
@Override
|
||||
public SubClusterId getApplicationHomeSubCluster(ApplicationId appId) throws Exception {
|
||||
final String cacheKey = buildCacheKey(className, GET_APPLICATION_HOME_SUBCLUSTER_CACHEID,
|
||||
appId.toString());
|
||||
CacheRequest<String, ?> cacheRequest = cache.getIfPresent(cacheKey);
|
||||
if (cacheRequest == null) {
|
||||
cacheRequest = buildGetApplicationHomeSubClusterRequest(className, appId);
|
||||
cache.put(cacheKey, cacheRequest);
|
||||
}
|
||||
CacheResponse<SubClusterId> response =
|
||||
ApplicationHomeSubClusterCacheResponse.class.cast(cacheRequest.getValue());
|
||||
return response.getItem();
|
||||
}
|
||||
|
||||
@Override
|
||||
public void removeSubCluster(boolean flushCache) {
|
||||
final String cacheKey = buildCacheKey(className, GET_SUBCLUSTERS_CACHEID,
|
||||
Boolean.toString(flushCache));
|
||||
cache.invalidate(cacheKey);
|
||||
}
|
||||
}
|
||||
@ -91,7 +91,7 @@ public void initCache(Configuration pConf, FederationStateStore pStateStore) {
|
||||
|
||||
@Override
|
||||
public void clearCache() {
|
||||
|
||||
this.cache.clear();
|
||||
this.cache = null;
|
||||
}
|
||||
|
||||
|
||||
@ -49,7 +49,8 @@ public class TestFederationCache {
|
||||
|
||||
@Parameterized.Parameters
|
||||
public static Collection<Class[]> getParameters() {
|
||||
return Arrays.asList(new Class[][] {{FederationGuavaCache.class}, {FederationJCache.class}});
|
||||
return Arrays.asList(new Class[][]{{FederationGuavaCache.class}, {FederationJCache.class},
|
||||
{FederationCaffeineCache.class}});
|
||||
}
|
||||
|
||||
private final long clusterTs = System.currentTimeMillis();
|
||||
|
||||
@ -66,6 +66,10 @@
|
||||
<groupId>com.google.inject</groupId>
|
||||
<artifactId>guice</artifactId>
|
||||
</exclusion>
|
||||
<exclusion>
|
||||
<artifactId>error_prone_annotations</artifactId>
|
||||
<groupId>com.google.errorprone</groupId>
|
||||
</exclusion>
|
||||
</exclusions>
|
||||
</dependency>
|
||||
|
||||
|
||||
@ -536,7 +536,7 @@ To enable cross-origin support (CORS) for the Yarn Router, please set the follow
|
||||
#### How to configure Router Cache
|
||||
|
||||
Cache is enabled by default. When we set the `yarn.federation.cache-ttl.secs` parameter and its value is greater than 0, Cache will be enabled.
|
||||
We currently provide two Cache implementations: `JCache` and `GuavaCache`.
|
||||
We currently provide three Cache implementations: `JCache`, `GuavaCache`, `CaffeineCache`
|
||||
|
||||
- JCache
|
||||
|
||||
@ -550,6 +550,12 @@ If we want to use JCache, we can configure `yarn.federation.cache.class` to `org
|
||||
This is a Cache implemented based on the Guava framework.
|
||||
If we want to use it, we can configure `yarn.federation.cache.class` to `org.apache.hadoop.yarn.server.federation.cache.FederationGuavaCache`.
|
||||
|
||||
- CaffeineCache
|
||||
|
||||
[CaffeineCache](https://github.com/ben-manes/caffeine) is a high-performance caching library for Java, offering better performance compared to Ehcache and Guava Cache.
|
||||
If we want to use it, we can configure `yarn.federation.cache.class` to `org.apache.hadoop.yarn.server.federation.cache.FederationCaffeineCache`.
|
||||
|
||||
|
||||
#### How to configure Router AuditLog
|
||||
|
||||
We can enable the AuditLog configuration for the Router and collect the AuditLog in a separate log file. We need to modify the configuration related to RouterAuditLog in the **conf/log4j.properties** file.
|
||||
|
||||
Loading…
Reference in New Issue
Block a user