-
Notifications
You must be signed in to change notification settings - Fork 24.9k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Changed how geoip cache is integrated with geoip processor. (#68890)
Backport #68581 of to 7.x branch. This change helps facilitate allowing maxmind databases to be updated at runtime. This will make is easier to purge the cache if a database changes. Made the following changes: * Changed how geoip processor integrates with the cache. The cache is moved from the geoip processor to DatabaseReaderLazyLoader class. * Changed the cache key from ip + response class to ip + database_path. * Moved GeoIpCache from IngestGeoIpPlugin class to be a top level class.
- Loading branch information
Showing
7 changed files
with
216 additions
and
218 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
89 changes: 89 additions & 0 deletions
89
modules/ingest-geoip/src/main/java/org/elasticsearch/ingest/geoip/GeoIpCache.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,89 @@ | ||
| /* | ||
| * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one | ||
| * or more contributor license agreements. Licensed under the Elastic License | ||
| * 2.0 and the Server Side Public License, v 1; you may not use this file except | ||
| * in compliance with, at your election, the Elastic License 2.0 or the Server | ||
| * Side Public License, v 1. | ||
| */ | ||
| package org.elasticsearch.ingest.geoip; | ||
|
|
||
| import com.maxmind.db.NodeCache; | ||
| import com.maxmind.geoip2.model.AbstractResponse; | ||
| import org.elasticsearch.common.cache.Cache; | ||
| import org.elasticsearch.common.cache.CacheBuilder; | ||
|
|
||
| import java.net.InetAddress; | ||
| import java.util.Objects; | ||
| import java.util.function.Function; | ||
|
|
||
| /** | ||
| * The in-memory cache for the geoip data. There should only be 1 instance of this class.. | ||
| * This cache differs from the maxmind's {@link NodeCache} such that this cache stores the deserialized Json objects to avoid the | ||
| * cost of deserialization for each lookup (cached or not). This comes at slight expense of higher memory usage, but significant | ||
| * reduction of CPU usage. | ||
| */ | ||
| final class GeoIpCache { | ||
| private final Cache<CacheKey, AbstractResponse> cache; | ||
|
|
||
| //package private for testing | ||
| GeoIpCache(long maxSize) { | ||
| if (maxSize < 0) { | ||
| throw new IllegalArgumentException("geoip max cache size must be 0 or greater"); | ||
| } | ||
| this.cache = CacheBuilder.<CacheKey, AbstractResponse>builder().setMaximumWeight(maxSize).build(); | ||
| } | ||
|
|
||
| @SuppressWarnings("unchecked") | ||
| <T extends AbstractResponse> T putIfAbsent(InetAddress ip, | ||
| String databasePath, | ||
| Function<InetAddress, AbstractResponse> retrieveFunction) { | ||
|
|
||
| //can't use cache.computeIfAbsent due to the elevated permissions for the jackson (run via the cache loader) | ||
| CacheKey cacheKey = new CacheKey(ip, databasePath); | ||
| //intentionally non-locking for simplicity...it's OK if we re-put the same key/value in the cache during a race condition. | ||
| AbstractResponse response = cache.get(cacheKey); | ||
| if (response == null) { | ||
| response = retrieveFunction.apply(ip); | ||
| cache.put(cacheKey, response); | ||
| } | ||
| return (T) response; | ||
| } | ||
|
|
||
| //only useful for testing | ||
| AbstractResponse get(InetAddress ip, String databasePath) { | ||
| CacheKey cacheKey = new CacheKey(ip, databasePath); | ||
| return cache.get(cacheKey); | ||
| } | ||
|
|
||
| /** | ||
| * The key to use for the cache. Since this cache can span multiple geoip processors that all use different databases, the database | ||
| * path is needed to be included in the cache key. For example, if we only used the IP address as the key the City and ASN the same | ||
| * IP may be in both with different values and we need to cache both. | ||
| */ | ||
| private static class CacheKey { | ||
|
|
||
| private final InetAddress ip; | ||
| private final String databasePath; | ||
|
|
||
| private CacheKey(InetAddress ip, String databasePath) { | ||
| this.ip = ip; | ||
| this.databasePath = databasePath; | ||
| } | ||
|
|
||
| //generated | ||
| @Override | ||
| public boolean equals(Object o) { | ||
| if (this == o) return true; | ||
| if (o == null || getClass() != o.getClass()) return false; | ||
| CacheKey cacheKey = (CacheKey) o; | ||
| return Objects.equals(ip, cacheKey.ip) && | ||
| Objects.equals(databasePath, cacheKey.databasePath); | ||
| } | ||
|
|
||
| //generated | ||
| @Override | ||
| public int hashCode() { | ||
| return Objects.hash(ip, databasePath); | ||
| } | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.