Skip to main content

ISPEnrichIP

Description

Looks up ISP information for an IP address and adds the information to FlowFile attributes. The ISP data is provided as a MaxMind ISP database. (Note that this is NOT the same as the GeoLite database utilized by some geo enrichment tools). 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.isp.<fieldName>

Tags

ISP, enrich, 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 NameAPI NameDefault ValueAllowable ValuesDescription
MaxMind Database File *Geo Database FilePath to Maxmind IP Enrichment Database File

Supports Expression Language, using Environment variables.
IP Address Attribute *IP Address AttributeThe 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 LevelWARNThe 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

NameDescription
foundWhere to route flow files after successfully enriching attributes with data provided by database
not foundWhere to route flow files after unsuccessfully enriching attributes because no data was found

Reads Attributes

This processor does not read attributes.

Writes Attributes

NameDescription
X.isp.asnThe Autonomous System Number (ASN) identified for the IP address
X.isp.asn.organizationThe Organization Associated with the ASN identified
X.isp.lookup.microsThe number of microseconds that the geo lookup took
X.isp.nameThe name of the ISP associated with the IP address provided
X.isp.organizationThe Organization associated with the IP address provided

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.

See Also