GeoIP Lookup

Enriche TenXObjects by geo-referencing ipAddress values via GeoIP DB lookup.

Database files reload on disk changes and can sync from GitHub.

Resolves IP addresses to: Continent, Country, Subdivision, City, Postal, Latitude, Longitude.

Configuration

To configure the GeoIP lookup module, Edit these settings.

Below is the default configuration from: geoIP/config.yaml.

# 🔟❎ 'run' GeoIP lookup configuration

# The GeoIP lookup geo-references TenXObjects based on their ipAddress field value.
# To learn more see https://doc.log10x.com/api/js/#TenXObject+ipAddress

# Set the 10x pipeline to 'run'
tenx: run

# =============================== Dependencies ================================

include: run/modules/initialize/geoIP

# =============================== GeoIP Options ===============================

geoIP:

  # 'file' specifies the MaxMind GeoIP DB (.mmdb) file to load.
  # To learn more see https://doc.log10x.com/api/js/#TenXLookup.loadGeoIPDB
  file: data/run/lookup/geo.mmdb

  # 'countryField' specifies the field name for country geo-reference data.
  # Defaults to "country". Set to "" to disable country enrichment.
  countryField: country

  # Uncomment the following fields to enable additional geo-reference data as needed:
  # continentField: continent
  # subdivisionField: subdivision
  # cityField: city
  # postalField: postal
  # latitudeField: latitude
  # longitudeField: longitude

Options

Specify the options below to configure the GeoIP lookup:

Name	Description
geoIPFile	MaxMind GeoIP file (.mmdb)
geoIPContinentField	Field name for continent geo-reference
geoIPCountryField	Field name for country geo-reference
geoIPSubdivisionField	Field name for subdivision geo-reference
geoIPCityField	Field name for city geo-reference
geoIPPostalField	Field name for postal code geo-reference
geoIPLatitudeField	Field name for latitude geo-reference
geoIPLongitudeField	Field name for longitude geo-reference

`geoIPFile`

MaxMind GeoIP file (.mmdb).

Type	Required
File	✔

The MaxMind GeoIP DB file (.mmdb) to load. To learn more, see loadGeoIPDB.

`geoIPContinentField`

Field name for continent geo-reference.

Type	Default
String	continent

Specifies the field name to store the continent geo-reference data (e.g., "my_continent"). Defaults to "continent". Set to "" to disable continent enrichment.

`geoIPCountryField`

Field name for country geo-reference.

Type	Default
String	country

Specifies the field name to store the country geo-reference data (e.g., "my_country"). Defaults to "country". Set to "" to disable country enrichment.

`geoIPSubdivisionField`

Field name for subdivision geo-reference.

Type	Default
String	subdivision

Specifies the field name to store the subdivision (state/region) geo-reference data (e.g., "my_region"). Defaults to "subdivision". Set to "" to disable subdivision enrichment.

`geoIPCityField`

Field name for city geo-reference.

Type	Default
String	city

Specifies the field name to store the city geo-reference data (e.g., "my_city"). Defaults to "city". Set to "" to disable city enrichment.

`geoIPPostalField`

Field name for postal code geo-reference.

Type	Default
String	postal

Specifies the field name to store the postal code geo-reference data (e.g., "my_postal"). Defaults to "postal". Set to "" to disable postal code enrichment.

`geoIPLatitudeField`

Field name for latitude geo-reference.

Type	Default
String	latitude

Specifies the field name to store the latitude geo-reference data (e.g., "my_latitude"). Defaults to "latitude". Set to "" to disable latitude enrichment.

`geoIPLongitudeField`

Field name for longitude geo-reference.

Type	Default
String	longitude

Specifies the field name to store the longitude geo-reference data (e.g., "my_longitude"). Defaults to "longitude". Set to "" to disable longitude enrichment.

This module is defined in geoIP/module.yaml.