GeoEnrichIP
Description
Looks up geolocation information for an IP address and adds the geo information to FlowFile attributes. The geo data is provided as a MaxMind database. The attribute that contains the IP address to lookup is provided by the 'IP Address Attribute' property. If the name of the attribute provided is 'X', then the the attributes added by enrichment will take the form X.geo.<fieldName>
Tags
enrich, geo, ip, maxmind
Properties
In the list below required Properties are shown with an asterisk (*). Other properties are considered optional. The table also indicates any default values, and whether a property supports the NiFi Expression Language.
| Display Name | API Name | Default Value | Allowable Values | Description |
|---|---|---|---|---|
| MaxMind Database File * | Geo Database File | Path to Maxmind IP Enrichment Database File Supports Expression Language, using Environment variables. | ||
| IP Address Attribute * | IP Address Attribute | The name of an attribute whose value is a dotted decimal IP address for which enrichment should occur Supports Expression Language, using FlowFile attributes and Environment variables. | ||
| Log Level * | Log Level | WARN | The Log Level to use when an IP is not found in the database. Accepted values: INFO, DEBUG, WARN, ERROR. Supports Expression Language, using FlowFile attributes and Environment variables. |
Dynamic Properties
This component does not support dynamic properties.
Relationships
| Name | Description |
|---|---|
| found | Where to route flow files after successfully enriching attributes with data provided by database |
| not found | Where to route flow files after unsuccessfully enriching attributes because no data was found |
Reads Attributes
This processor does not read attributes.
Writes Attributes
| Name | Description |
|---|---|
| X.geo.accuracy | The accuracy radius if provided by the database (in Kilometers) |
| X.geo.city | The city identified for the IP address |
| X.geo.country | The country identified for this IP address |
| X.geo.country.isocode | The ISO Code for the country identified |
| X.geo.latitude | The latitude identified for this IP address |
| X.geo.longitude | The longitude identified for this IP address |
| X.geo.lookup.micros | The number of microseconds that the geo lookup took |
| X.geo.postalcode | The postal code for the country identified |
| X.geo.subdivision.N | Each subdivision that is identified for this IP address is added with a one-up number appended to the attribute name, starting with 0 |
| X.geo.subdivision.isocode.N | The ISO code for the subdivision that is identified by X.geo.subdivision.N |
State Management
This component does not store state.
Restricted
This component is not restricted.
Input Requirement
This component requires an incoming relationship.
System Resource Considerations
This component does not specify system resource considerations.