metron-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From nickwallen <...@git.apache.org>
Subject [GitHub] incubator-metron pull request #421: METRON-283 Migrate Geo Enrichment outsid...
Date Wed, 25 Jan 2017 16:16:46 GMT
Github user nickwallen commented on a diff in the pull request:

    https://github.com/apache/incubator-metron/pull/421#discussion_r97810219
  
    --- Diff: metron-platform/metron-enrichment/src/main/java/org/apache/metron/enrichment/adapters/geo/GeoLiteDatabase.java
---
    @@ -0,0 +1,184 @@
    +/*
    + * 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
    + *
    + *     http://www.apache.org/licenses/LICENSE-2.0
    + *
    + * 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.metron.enrichment.adapters.geo;
    +
    +import com.maxmind.db.CHMCache;
    +import com.maxmind.geoip2.DatabaseReader;
    +import com.maxmind.geoip2.exception.GeoIp2Exception;
    +import com.maxmind.geoip2.model.CityResponse;
    +import com.maxmind.geoip2.record.City;
    +import com.maxmind.geoip2.record.Country;
    +import com.maxmind.geoip2.record.Location;
    +import com.maxmind.geoip2.record.Postal;
    +import org.apache.commons.validator.routines.InetAddressValidator;
    +import org.apache.hadoop.conf.Configuration;
    +import org.apache.hadoop.fs.FileSystem;
    +import org.apache.hadoop.fs.Path;
    +import org.slf4j.Logger;
    +import org.slf4j.LoggerFactory;
    +
    +import java.io.IOException;
    +import java.net.InetAddress;
    +import java.net.UnknownHostException;
    +import java.util.HashMap;
    +import java.util.Map;
    +import java.util.Optional;
    +import java.util.concurrent.locks.Lock;
    +import java.util.concurrent.locks.ReentrantReadWriteLock;
    +import java.util.zip.GZIPInputStream;
    +
    +public enum GeoLiteDatabase {
    +  INSTANCE;
    +
    +  protected static final Logger LOG = LoggerFactory.getLogger(GeoLiteDatabase.class);
    +  public static final String GEO_HDFS_FILE = "geo.hdfs.file";
    +  public static final String GEO_HDFS_FILE_DEFAULT = "/apps/metron/geo/default/GeoLite2-City.mmdb.gz";
    +
    +  private static ReentrantReadWriteLock lock = new ReentrantReadWriteLock();
    +  private static final Lock readLock = lock.readLock();
    +  private static final Lock writeLock = lock.writeLock();
    +  private static InetAddressValidator ipvalidator = new InetAddressValidator();
    +  private static volatile String hdfsLoc = GEO_HDFS_FILE_DEFAULT;
    +  private static DatabaseReader reader = null;
    +
    +  public synchronized void updateIfNecessary(Map<String, Object> globalConfig)
{
    +    // Reload database if necessary (file changes on HDFS)
    +    LOG.trace("[Metron] Determining if GeoIpDatabase update required");
    +    String hdfsFile = GEO_HDFS_FILE_DEFAULT;
    +    if (globalConfig != null) {
    +      hdfsFile = (String) globalConfig.getOrDefault(GEO_HDFS_FILE, GEO_HDFS_FILE_DEFAULT);
    +    }
    +
    +    // Always update if we don't have a DatabaseReader
    +    if (reader == null || !hdfsLoc.equals(hdfsFile)) {
    +      // Update
    +      hdfsLoc = hdfsFile;
    +      update(hdfsFile);
    +    } else {
    +      LOG.trace("[Metron] Update to GeoIpDatabase unnecessary");
    +    }
    +  }
    +
    +  @SuppressWarnings("unchecked")
    +  public void update(String hdfsFile) {
    +    // If nothing is set (or it's been unset, use the defaults)
    +    if (hdfsFile == null || hdfsFile.isEmpty()) {
    +      LOG.debug("[Metron] Using default for {}: {}", GEO_HDFS_FILE, GEO_HDFS_FILE_DEFAULT);
    +      hdfsFile = GEO_HDFS_FILE_DEFAULT;
    +    }
    +
    +    FileSystem fs;
    +    try {
    +      fs = FileSystem.get(new Configuration());
    +    } catch (IOException e) {
    +      LOG.error("[Metron] Unable to retrieve get HDFS FileSystem");
    +      throw new IllegalStateException("[Metron] Unable to get HDFS FileSystem");
    +    }
    +
    +    try (GZIPInputStream gis = new GZIPInputStream(fs.open(new Path(hdfsFile)))) {
    +      writeLock.lock();
    +      LOG.info("[Metron] Update to GeoIP data started with {}", hdfsFile);
    +      // InputStream based DatabaseReaders are always in memory.
    +      DatabaseReader newReader = new DatabaseReader.Builder(gis).withCache(new CHMCache()).build();
    +      DatabaseReader oldReader = reader;
    +      reader = newReader;
    +      // If we've never set a reader, don't close the old one
    +      if (oldReader != null) {
    +        oldReader.close();
    +      }
    +      LOG.info("[Metron] Finished update to GeoIP data started with {}", hdfsFile);
    +    } catch (IOException e) {
    +      LOG.error("[Metron] Unable to open new database file {}", hdfsFile, e);
    +      throw new IllegalStateException("[Metron] Unable to update MaxMind database");
    +    } finally {
    +      // Don't unlock if the try failed
    +      if (lock.isWriteLocked()) {
    +        writeLock.unlock();
    +      }
    +    }
    +  }
    +
    +  // Optional.empty means that we don't have any geo location in database.
    +  // Optional exists, but empty means local IP (valid, but no info will be in the DB)
    +  @SuppressWarnings("unchecked")
    +  public Optional<HashMap<String, String>> get(String ip) {
    +    // Call get every single time, returns current version. Updates behind the scenes.
    +    LOG.trace("[Metron] Called GeoIpDatabase.get({})", ip);
    +    InetAddress addr = null;
    +    try {
    +      addr = InetAddress.getByName(ip);
    +    } catch (UnknownHostException e) {
    +      LOG.warn("[Metron] No result found for IP {}", ip, e);
    +      return Optional.empty();
    +    }
    +    if (isLocalAddress(ip, addr)) {
    +      return Optional.of(new HashMap());
    +    }
    +
    +    try {
    +      readLock.lock();
    +      addr = InetAddress.getByName(ip);
    +      CityResponse cityResponse = reader.city(addr);
    +      HashMap<String, String> geoInfo = new HashMap<>();
    +
    +      Country country = cityResponse.getCountry();
    +      City city = cityResponse.getCity();
    +      Postal postal = cityResponse.getPostal();
    +      Location location = cityResponse.getLocation();
    +
    +      geoInfo.put("locID", convertNullToEmptyString(country.getGeoNameId()));
    +      geoInfo.put("country", convertNullToEmptyString(country.getIsoCode()));
    +      geoInfo.put("city", convertNullToEmptyString(city.getName()));
    +      geoInfo.put("postalCode", convertNullToEmptyString(postal.getCode()));
    +      geoInfo.put("dmaCode", convertNullToEmptyString(location.getMetroCode()));
    +
    +      Double latitudeRaw = location.getLatitude();
    +      String latitude = convertNullToEmptyString(latitudeRaw);
    +      geoInfo.put("latitude", latitude);
    +
    +      Double longitudeRaw = location.getLongitude();
    +      String longitude = convertNullToEmptyString(longitudeRaw);
    +      geoInfo.put("longitude", longitude);
    +
    +      if (latitudeRaw == null || longitudeRaw == null) {
    +        geoInfo.put("location_point", "");
    +      } else {
    +        geoInfo.put("location_point", latitude + "," + longitude);
    +      }
    +
    +      return Optional.of(geoInfo);
    +    } catch (UnknownHostException e) {
    +      LOG.warn("[Metron] No result found for IP {}", ip);
    +    } catch (GeoIp2Exception | IOException e) {
    +      LOG.warn("[Metron] GeoLite2 DB encountered an error", e);
    +    } finally {
    +      readLock.unlock();
    +    }
    +    return Optional.empty();
    +  }
    +
    +  protected String convertNullToEmptyString(Object raw) {
    +    return raw == null ? "" : String.valueOf(raw);
    +  }
    +
    +  private boolean isLocalAddress(String ipStr, InetAddress addr) {
    +    return addr.isAnyLocalAddress() || addr.isLoopbackAddress()
    +            || addr.isSiteLocalAddress() || addr.isMulticastAddress()
    +            || !ipvalidator.isValidInet4Address(ipStr);
    +  }
    --- End diff --
    
    Method name may be a little misleading.  It is more answering the question of whether
an IP is eligible for geo-enrichment; not whether it is a local address.


---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---

Mime
View raw message