Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Preload spec in serving cache #152

Merged
merged 2 commits into from
Mar 10, 2019
Merged

Preload spec in serving cache #152

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
315cdd2
Preload spec in serving cache
Mar 6, 2019
06226fe
Disable async refresh and only periodically refresh cache
Mar 7, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions serving/pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -232,6 +232,13 @@
<version>2.23.0</version>
<scope>test</scope>
</dependency>

<dependency>
<groupId>com.google.guava</groupId>
<artifactId>guava-testlib</artifactId>
<version>26.0-jre</version>
<scope>test</scope>
</dependency>
</dependencies>


Expand Down
42 changes: 39 additions & 3 deletions serving/src/main/java/feast/serving/config/ServingApiConfiguration.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,19 +17,25 @@

package feast.serving.config;

import com.google.common.base.Ticker;
import com.google.common.util.concurrent.ListeningExecutorService;
import com.google.common.util.concurrent.MoreExecutors;
import com.google.common.util.concurrent.ThreadFactoryBuilder;
import feast.serving.service.CachedSpecStorage;
import feast.serving.service.CoreService;
import feast.serving.service.FeatureStorageRegistry;
import feast.serving.service.SpecStorage;
import feast.specs.StorageSpecProto.StorageSpec;
import io.opentracing.Tracer;
import io.opentracing.contrib.concurrent.TracedExecutorService;
import java.time.Duration;
import java.util.List;
import java.util.Map;
import java.util.concurrent.ExecutorService;
import java.util.concurrent.Executors;
import java.util.concurrent.ScheduledExecutorService;
import java.util.concurrent.ThreadFactory;
import java.util.concurrent.TimeUnit;
import lombok.extern.slf4j.Slf4j;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.beans.factory.annotation.Value;
Expand Down Expand Up @@ -66,9 +72,39 @@ public AppConfig getAppConfig(
@Bean
public SpecStorage getCoreServiceSpecStorage(
@Value("${feast.core.host}") String coreServiceHost,
@Value("${feast.core.grpc.port}") String coreServicePort) {
return new CachedSpecStorage(
new CoreService(coreServiceHost, Integer.parseInt(coreServicePort)));
@Value("${feast.core.grpc.port}") String coreServicePort,
@Value("${feast.cacheDurationMinute}") int cacheDurationMinute) {
Duration cacheDuration = Duration.ofMinutes(cacheDurationMinute);

ThreadFactory threadFactory = new ThreadFactoryBuilder().setNameFormat("cache-refresh-thread")
.setDaemon(true)
.build();
ExecutorService parentExecutor = Executors.newSingleThreadExecutor(threadFactory);
final ListeningExecutorService executorService = MoreExecutors.listeningDecorator(parentExecutor);

ScheduledExecutorService scheduledExecutorService = Executors.newSingleThreadScheduledExecutor();
final CachedSpecStorage cachedSpecStorage =
new CachedSpecStorage(
new CoreService(coreServiceHost, Integer.parseInt(coreServicePort)),
executorService,
cacheDuration,
Ticker.systemTicker());

// reload all specs including new ones periodically
scheduledExecutorService.schedule(new Runnable() {
@Override
public void run() {
cachedSpecStorage.populateCache();
}
}, cacheDurationMinute, TimeUnit.MINUTES);

// load all specs during start up
try {
cachedSpecStorage.populateCache();
} catch (Exception e) {
log.error("Unable to preload feast's spec");
}
return cachedSpecStorage;
}

@Bean
Expand Down
88 changes: 66 additions & 22 deletions serving/src/main/java/feast/serving/service/CachedSpecStorage.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,22 +17,26 @@

package feast.serving.service;

import com.google.common.base.Ticker;
import com.google.common.cache.CacheBuilder;
import com.google.common.cache.CacheLoader;
import com.google.common.cache.LoadingCache;
import lombok.extern.slf4j.Slf4j;
import com.google.common.util.concurrent.ListenableFuture;
import com.google.common.util.concurrent.ListeningExecutorService;
import feast.serving.exception.SpecRetrievalException;
import feast.specs.EntitySpecProto.EntitySpec;
import feast.specs.FeatureSpecProto.FeatureSpec;
import feast.specs.StorageSpecProto.StorageSpec;

import java.time.Duration;
import java.util.Collections;
import java.util.Map;
import lombok.extern.slf4j.Slf4j;

/** SpecStorage implementation with built-in in-memory cache. */
@Slf4j
public class CachedSpecStorage implements SpecStorage {
private static final int MAX_SPEC_COUNT = 1000;

private final CoreService coreService;
private final LoadingCache<String, EntitySpec> entitySpecCache;
private final CacheLoader<String, EntitySpec> entitySpecLoader;
Expand All @@ -41,14 +45,11 @@ public class CachedSpecStorage implements SpecStorage {
private final LoadingCache<String, StorageSpec> storageSpecCache;
private final CacheLoader<String, StorageSpec> storageSpecLoader;

private static final Duration CACHE_DURATION;
private static final int MAX_SPEC_COUNT = 1000;

static {
CACHE_DURATION = Duration.ofMinutes(30);
}

public CachedSpecStorage(CoreService coreService) {
public CachedSpecStorage(
CoreService coreService,
ListeningExecutorService executorService,
Duration cacheDuration,
Ticker ticker) {
this.coreService = coreService;
entitySpecLoader =
new CacheLoader<String, EntitySpec>() {
Expand All @@ -58,14 +59,25 @@ public EntitySpec load(String key) throws Exception {
}

@Override
public Map<String, EntitySpec> loadAll(Iterable<? extends String> keys) throws Exception {
return coreService.getEntitySpecs((Iterable<String>) keys);
public ListenableFuture<EntitySpec> reload(String key, EntitySpec oldValue)
Copy link
Contributor

@tims tims Mar 7, 2019 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think these can be simplified to:

entitySpecLoader = CacheLoader.asyncReloading(
        CacheLoader.from(
            (String key) -> coreService.getEntitySpecs(Collections.singletonList(key)).get(key)),
        executorService);

featureSpecLoader = CacheLoader.asyncReloading(
        CacheLoader.from(
            (String key) -> coreService.getFeatureSpecs(Collections.singletonList(key)).get(key)),
        executorService);

etc..

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The asyncReloading won't return old value if anything goes wrong during refresh, that's why I used a more verbose implementation.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ah neat

throws Exception {
return executorService.submit(
() -> {
EntitySpec result = oldValue;
try {
result = coreService.getEntitySpecs(Collections.singleton(key)).get(key);
} catch (Exception e) {
log.error("Error reloading entity spec");
}
return result;
});
}
};
entitySpecCache =
CacheBuilder.newBuilder()
.maximumSize(MAX_SPEC_COUNT)
.expireAfterAccess(CACHE_DURATION)
.refreshAfterWrite(cacheDuration)
.ticker(ticker)
.build(entitySpecLoader);

featureSpecLoader =
Expand All @@ -76,34 +88,54 @@ public FeatureSpec load(String key) throws Exception {
}

@Override
public Map<String, FeatureSpec> loadAll(Iterable<? extends String> keys)
public ListenableFuture<FeatureSpec> reload(String key, FeatureSpec oldValue)
throws Exception {
return coreService.getFeatureSpecs((Iterable<String>) keys);
return executorService.submit(
() -> {
FeatureSpec result = oldValue;
try {
result = coreService.getFeatureSpecs(Collections.singleton(key)).get(key);
} catch (Exception e) {
log.error("Error reloading feature spec");
}
return result;
});
}
};
featureSpecCache =
CacheBuilder.newBuilder()
.maximumSize(MAX_SPEC_COUNT)
.expireAfterAccess(CACHE_DURATION)
.refreshAfterWrite(cacheDuration)
.ticker(ticker)
.build(featureSpecLoader);

storageSpecLoader =
new CacheLoader<String, StorageSpec>() {
@Override
public Map<String, StorageSpec> loadAll(Iterable<? extends String> keys)
throws Exception {
return coreService.getStorageSpecs((Iterable<String>) keys);
public StorageSpec load(String key) throws Exception {
return coreService.getStorageSpecs(Collections.singleton(key)).get(key);
}

@Override
public StorageSpec load(String key) throws Exception {
return coreService.getStorageSpecs(Collections.singleton(key)).get(key);
public ListenableFuture<StorageSpec> reload(String key, StorageSpec oldValue)
throws Exception {
return executorService.submit(
() -> {
StorageSpec result = oldValue;
try {
result = coreService.getStorageSpecs(Collections.singleton(key)).get(key);
} catch (Exception e) {
log.error("Error reloading storage spec");
}
return result;
});
}
};
storageSpecCache =
CacheBuilder.newBuilder()
.maximumSize(MAX_SPEC_COUNT)
.expireAfterAccess(CACHE_DURATION)
.refreshAfterWrite(cacheDuration)
.ticker(ticker)
.build(storageSpecLoader);
}

Expand Down Expand Up @@ -177,4 +209,16 @@ public Map<String, StorageSpec> getAllStorageSpecs() {
public boolean isConnected() {
return coreService.isConnected();
}

/** Preload all spec into cache. */
public void populateCache() {
Copy link
Contributor

@tims tims Mar 7, 2019 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

With a MAX_SPEC_COUNT of 1000, once you have more than that, you're going to be evicting things that might actually be commonly used every 5 minutes. Is that a problem?

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah, that's probably introduce problem. Do you think it's better to not limit the cache size based on the number of entry?

Map<String, FeatureSpec> featureSpecMap = coreService.getAllFeatureSpecs();
featureSpecCache.putAll(featureSpecMap);

Map<String, EntitySpec> entitySpecMap = coreService.getAllEntitySpecs();
entitySpecCache.putAll(entitySpecMap);

Map<String, StorageSpec> storageSpecMap = coreService.getAllStorageSpecs();
storageSpecCache.putAll(storageSpecMap);
}
}
1 change: 1 addition & 0 deletions serving/src/main/resources/application.properties
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@ feast.maxentity=${FEAST_MAX_ENTITY_PER_BATCH:2000}
feast.timeout=${FEAST_RETRIEVAL_TIMEOUT:5}
feast.redispool.maxsize=${FEAST_REDIS_POOL_MAX_SIZE:128}
feast.redispool.maxidle=${FEAST_REDIS_POOL_MAX_IDLE:16}
feast.cacheDurationMinute=${FEAST_SPEC_CACHE_DURATION_MINUTE:5}

statsd.host= ${STATSD_HOST:localhost}
statsd.port= ${STATSD_PORT:8125}
Expand Down
115 changes: 115 additions & 0 deletions serving/src/test/java/feast/serving/service/CachedSpecStorageTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,115 @@
package feast.serving.service;

import static org.hamcrest.Matchers.equalTo;
import static org.junit.Assert.*;
import static org.mockito.ArgumentMatchers.any;
import static org.mockito.Mockito.mock;
import static org.mockito.Mockito.times;
import static org.mockito.Mockito.verify;
import static org.mockito.Mockito.when;

import com.google.common.testing.FakeTicker;
import com.google.common.util.concurrent.ListeningExecutorService;
import com.google.common.util.concurrent.MoreExecutors;
import feast.specs.EntitySpecProto.EntitySpec;
import feast.specs.FeatureSpecProto.FeatureSpec;
import feast.specs.StorageSpecProto.StorageSpec;
import java.time.Duration;
import java.util.Collections;
import java.util.HashMap;
import java.util.Map;
import java.util.concurrent.Executors;
import java.util.concurrent.TimeUnit;
import org.junit.Before;
import org.junit.Test;

public class CachedSpecStorageTest {

private FakeTicker fakeTicker;
private CoreService coreService;
private CachedSpecStorage cachedSpecStorage;

@Before
public void setUp() throws Exception {
fakeTicker = new FakeTicker();
coreService = mock(CoreService.class);
ListeningExecutorService executorService = MoreExecutors.listeningDecorator(Executors.newSingleThreadExecutor());
cachedSpecStorage = new CachedSpecStorage(coreService, executorService,
Duration.ofSeconds(5), fakeTicker);
}

@Test
public void shouldNotBeNull() {
assertNotNull(cachedSpecStorage);
}

@Test
public void testPopulateCache() {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

can you add a test for what happens when you exceed the max size of cache in populating. So we're explicit about the intended behaviour.

Map<String, FeatureSpec> featureSpecMap = new HashMap<>();
featureSpecMap.put("feature_1", mock(FeatureSpec.class));

Map<String, StorageSpec> storageSpecMap = new HashMap<>();
storageSpecMap.put("storage_1", mock(StorageSpec.class));

Map<String, EntitySpec> entitySpecMap = new HashMap<>();
entitySpecMap.put("entity_1", mock(EntitySpec.class));

when(coreService.getAllFeatureSpecs()).thenReturn(featureSpecMap);
when(coreService.getAllEntitySpecs()).thenReturn(entitySpecMap);
when(coreService.getAllStorageSpecs()).thenReturn(storageSpecMap);

cachedSpecStorage.populateCache();
Map<String, FeatureSpec> result = cachedSpecStorage.getFeatureSpecs(Collections.singletonList("feature_1"));
Map<String, StorageSpec> result1 = cachedSpecStorage.getStorageSpecs(Collections.singletonList("storage_1"));
Map<String, EntitySpec> result2 = cachedSpecStorage.getEntitySpecs(Collections.singletonList("entity_1"));

assertThat(result.size(), equalTo(1));
assertThat(result1.size(), equalTo(1));
assertThat(result2.size(), equalTo(1));

verify(coreService, times(0)).getFeatureSpecs(any(Iterable.class));
verify(coreService, times(0)).getStorageSpecs(any(Iterable.class));
verify(coreService, times(0)).getEntitySpecs(any(Iterable.class));
}

@Test
public void reloadFailureShouldReturnOldValue() {
Map<String, FeatureSpec> featureSpecMap = new HashMap<>();
featureSpecMap.put("feature_1", mock(FeatureSpec.class));

Map<String, StorageSpec> storageSpecMap = new HashMap<>();
storageSpecMap.put("storage_1", mock(StorageSpec.class));

Map<String, EntitySpec> entitySpecMap = new HashMap<>();
entitySpecMap.put("entity_1", mock(EntitySpec.class));

when(coreService.getAllFeatureSpecs()).thenReturn(featureSpecMap);
when(coreService.getFeatureSpecs(any(Iterable.class))).thenThrow(new RuntimeException("error"));
when(coreService.getAllEntitySpecs()).thenReturn(entitySpecMap);
when(coreService.getEntitySpecs(any(Iterable.class))).thenThrow(new RuntimeException("error"));
when(coreService.getAllStorageSpecs()).thenReturn(storageSpecMap);
when(coreService.getStorageSpecs(any(Iterable.class))).thenThrow(new RuntimeException("error"));


cachedSpecStorage.populateCache();
Map<String, FeatureSpec> result = cachedSpecStorage.getFeatureSpecs(Collections.singletonList("feature_1"));
Map<String, StorageSpec> result1 = cachedSpecStorage.getStorageSpecs(Collections.singletonList("storage_1"));
Map<String, EntitySpec> result2 = cachedSpecStorage.getEntitySpecs(Collections.singletonList("entity_1"));

assertThat(result.size(), equalTo(1));
assertThat(result1.size(), equalTo(1));
assertThat(result2.size(), equalTo(1));
verify(coreService, times(0)).getFeatureSpecs(any(Iterable.class));
verify(coreService, times(0)).getStorageSpecs(any(Iterable.class));
verify(coreService, times(0)).getEntitySpecs(any(Iterable.class));

fakeTicker.advance(6, TimeUnit.SECONDS);

result = cachedSpecStorage.getFeatureSpecs(Collections.singletonList("feature_1"));
result1 = cachedSpecStorage.getStorageSpecs(Collections.singletonList("storage_1"));
result2 = cachedSpecStorage.getEntitySpecs(Collections.singletonList("entity_1"));
assertThat(result.size(), equalTo(1));
assertThat(result1.size(), equalTo(1));
assertThat(result2.size(), equalTo(1));
}
}