CalculateRecordStats

Description:

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.

Additional Details...

Tags:

record, stats, metrics

Properties:

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.

NameDefault ValueAllowable ValuesDescription
Record ReaderController Service API:
RecordReaderFactory
Implementations: Syslog5424Reader
AvroReader
JsonPathReader
ScriptedReader
XMLReader
GrokReader
JsonTreeReader
SyslogReader
CSVReader
A record reader to use for reading the records.
record-stats-limit10Limit 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)

Relationships:

NameDescription
successIf a flowfile is successfully processed, it goes here.
failureIf a flowfile fails to be processed, it goes here.

Reads Attributes:

None specified.

Writes Attributes:

NameDescription
record.countA count of the records in the record set in the flowfile.
recordStats.<User Defined Property Name>.countA count of the records that contain a value for the user defined property.
recordStats.<User Defined Property Name>.<value>.countEach 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.

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:

None specified.