This processor polls the notification events provided by the HdfsAdmin API. Since this uses the HdfsAdmin APIs it is required to run as an HDFS super user. Currently there are six types of events (append, close, create, metadata, rename, and unlink). Please see org.apache.hadoop.hdfs.inotify.Event documentation for full explanations of each event. This processor will poll for new events based on a defined duration. For each event received a new flow file will be created with the expected attributes and the event itself serialized to JSON and written to the flow file's content. For example, if event.type is APPEND then the content of the flow file will contain a JSON file containing the information about the append event. If successful the flow files are sent to the 'success' relationship. Be careful of where the generated flow files are stored. If the flow files are stored in one of processor's watch directories there will be a never ending flow of events. It is also important to be aware that this processor must consume all events. The filtering must happen within the processor. This is because the HDFS admin's event notifications API does not have filtering.
hadoop, events, inotify, notifications, filesystem
In the list below, the names of required properties appear in bold. Any other properties (not in bold) 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 |
|---|---|---|---|---|
| Hadoop Configuration Resources | Hadoop Configuration Resources | A file or comma separated list of files which contains the Hadoop file system configuration. Without this, Hadoop will search the classpath for a 'core-site.xml' and 'hdfs-site.xml' file or will revert to a default configuration. To use swebhdfs, see 'Additional Details' section of PutHDFS's documentation. This property expects a comma-separated list of file resources. Supports Expression Language: true (will be evaluated using variable registry only) | ||
| Kerberos Credentials Service | kerberos-credentials-service | Controller Service API: KerberosCredentialsService Implementation: KeytabCredentialsService | Specifies the Kerberos Credentials Controller Service that should be used for authenticating with Kerberos | |
| Kerberos User Service | kerberos-user-service | Controller Service API: KerberosUserService Implementations: KerberosPasswordUserService KerberosKeytabUserService KerberosTicketCacheUserService | Specifies the Kerberos User Controller Service that should be used for authenticating with Kerberos | |
| Kerberos Principal | Kerberos Principal | Kerberos principal to authenticate as. Requires nifi.kerberos.krb5.file to be set in your nifi.properties Supports Expression Language: true (will be evaluated using variable registry only) | ||
| Kerberos Keytab | Kerberos Keytab | Kerberos keytab associated with the principal. Requires nifi.kerberos.krb5.file to be set in your nifi.properties This property requires exactly one file to be provided.. Supports Expression Language: true (will be evaluated using variable registry only) | ||
| Kerberos Password | Kerberos Password | Kerberos password associated with the principal. Sensitive Property: true | ||
| Kerberos Relogin Period | Kerberos Relogin Period | 4 hours | Period of time which should pass before attempting a kerberos relogin.
This property has been deprecated, and has no effect on processing. Relogins now occur automatically. Supports Expression Language: true (will be evaluated using variable registry only) | |
| Additional Classpath Resources | Additional Classpath Resources | A comma-separated list of paths to files and/or directories that will be added to the classpath and used for loading native libraries. When specifying a directory, all files with in the directory will be added to the classpath, but further sub-directories will not be included. This property expects a comma-separated list of resources. Each of the resources may be of any of the following types: file, directory. | ||
| Poll Duration | Poll Duration | 1 second | The time before the polling method returns with the next batch of events if they exist. It may exceed this amount of time by up to the time required for an RPC to the NameNode. | |
| HDFS Path to Watch | HDFS Path to Watch | The HDFS path to get event notifications for. This property accepts both expression language and regular expressions. This will be evaluated during the OnScheduled phase. Supports Expression Language: true (will be evaluated using variable registry only) | ||
| Ignore Hidden Files | Ignore Hidden Files | false |
| If true and the final component of the path associated with a given event starts with a '.' then that event will not be processed. |
| Event Types to Filter On | Event Types to Filter On | append, close, create, metadata, rename, unlink | A comma-separated list of event types to process. Valid event types are: append, close, create, metadata, rename, and unlink. Case does not matter. | |
| IOException Retries During Event Polling | IOException Retries During Event Polling | 3 | According to the HDFS admin API for event polling it is good to retry at least a few times. This number defines how many times the poll will be retried if it throws an IOException. |
| Name | Description |
|---|---|
| success | A flow file with updated information about a specific event will be sent to this relationship. |
| Name | Description |
|---|---|
| mime.type | This is always application/json. |
| hdfs.inotify.event.type | This will specify the specific HDFS notification event type. Currently there are six types of events (append, close, create, metadata, rename, and unlink). |
| hdfs.inotify.event.path | The specific path that the event is tied to. |
| Scope | Description |
|---|---|
| CLUSTER | The last used transaction id is stored. This is used |