A processor that can count the number of items in a record set, as well as provide counts based on user-defined criteria on subsets of the record set.
record, stats, metrics
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 |
|---|---|---|---|---|
| Record Reader | record-stats-reader | Controller Service API: RecordReaderFactory Implementations: JsonPathReader Syslog5424Reader CSVReader JsonTreeReader GrokReader ExcelReader ParquetReader ReaderLookup CEFReader WindowsEventLogReader ProtobufReader SyslogReader AvroReader XMLReader ScriptedReader YamlTreeReader | A record reader to use for reading the records. | |
| record-stats-limit | record-stats-limit | 10 | Limit the number of individual stats that are returned for each record path to the top N results. Supports Expression Language: true (will be evaluated using flow file attributes and variable registry) |
Supports Sensitive Dynamic Properties: No
Dynamic Properties allow the user to specify both the name and value of a property.
| Name | Value | Description |
|---|---|---|
| Record Path property | The Record Path value | A Record Path value, pointing to a field to be counted Supports Expression Language: true (will be evaluated using flow file attributes and variable registry) |
| Name | Description |
|---|---|
| success | If a flowfile is successfully processed, it goes here. |
| failure | If a flowfile fails to be processed, it goes here. |
| Name | Description |
|---|---|
| record.count | A count of the records in the record set in the FlowFile. |
| recordStats.<User Defined Property Name>.count | A count of the records that contain a value for the user defined property. |
| recordStats.<User Defined Property Name>.<value>.count | Each value discovered for the user defined property will have its own count attribute. Total number of top N value counts to be added is defined by the limit configuration. |