NIFI-5231 Added RecordStats processor. #2737

MikeThomsen · 2018-05-24T11:54:32Z

Thank you for submitting a contribution to Apache NiFi.

In order to streamline the review of the contribution we ask you
to ensure the following steps have been taken:

For all changes:

Is there a JIRA ticket associated with this PR? Is it referenced
in the commit message?
Does your PR title start with NIFI-XXXX where XXXX is the JIRA number you are trying to resolve? Pay particular attention to the hyphen "-" character.
Has your PR been rebased against the latest commit within the target branch (typically master)?
Is your initial contribution a single, squashed commit?

For code changes:

Have you ensured that the full suite of tests is executed via mvn -Pcontrib-check clean install at the root nifi folder?
Have you written or updated unit tests to verify your changes?
If adding new dependencies to the code, are these dependencies licensed in a way that is compatible for inclusion under ASF 2.0?
If applicable, have you updated the LICENSE file, including the main LICENSE file under nifi-assembly?
If applicable, have you updated the NOTICE file, including the main NOTICE file found under nifi-assembly?
If adding new Properties, have you added .displayName in addition to .name (programmatic access) for each of the new properties?

For documentation related changes:

Have you ensured that format looks appropriate for the output in which it is rendered?

Note:

Please ensure that once the PR is submitted, you check travis-ci for build issues and submit an update to your PR as soon as possible.

ottobackwards · 2018-05-24T12:21:53Z

@MikeThomsen this is cool.

The only thing it makes me wonder is if this kind of data can't be automatically generated and sent to a repository, almost like a new ( or actual ) reporting task.

This seems like it lends itself to time series analysis like other things.

Nifi doesn't necessarily have to provide that repo.

MikeThomsen · 2018-05-24T13:10:49Z

I'm not sure how that'd work out because you need to actually read the flowfiles and calculate the stats.

ottobackwards · 2018-05-24T13:57:59Z

prob the reader and write would have to get some context passed where they can track states or increment stats, then be configured with a 'reporting' task to send the stats from a given context to

MikeThomsen · 2018-05-24T14:00:15Z

Not sure if I like that approach because it could get pretty complicated to make the hand-off not impact the processing to any meaningful degree. The beauty of what we did was it just puts the data into the provenance repository and there aren't that many flowfiles to track. Maybe a few hundred thousand over the entire data set if we use appropriately-sized batches from GetMongo. NiFi handles that like a champ and s2s prov reporting has no probably rapid-fire sending it over to our tracking instance of NiFi.

ottobackwards · 2018-05-24T14:51:50Z

That makes sense, just thinking it through, and obviously I don't understand everything as well ;)
I guess I never thought of provenance as including perf and stats stuff, so it seems like putting it there is just doing it because that is the thing that is present to use, co-opting it so to speak.

MikeThomsen · 2018-05-24T19:53:49Z

I'm not too familiar with the deep internals of the framework either. What we've seen is that with the records API it just makes sense to leverage the provenance system because it already tracks the attributes in a clean way you can leverage for stuff like giving managers a nice little ELK dashboard for the warm fuzzies.

ottobackwards

@MikeThomsen thanks for the contribution, just a couple of nits.

ottobackwards · 2018-05-24T20:06:54Z

.../nifi-standard-processors/src/main/java/org/apache/nifi/processors/standard/RecordStats.java

+
+    protected Map<String, String> getStats(FlowFile input, Map<String, RecordPath> paths, ProcessContext context, ProcessSession session) {
+        try (InputStream is = session.read(input)) {
+            RecordReaderFactory factory = context.getProperty(RECORD_READER).asControllerService(RecordReaderFactory.class);


input and is as var names is confusing here, can we name them closer to what they are to keep them straight?
flowFile and inputStream?
There is only one flowFile to track in this processor so none to get fancy ;)

ottobackwards · 2018-05-24T20:33:27Z

.../nifi-standard-processors/src/main/java/org/apache/nifi/processors/standard/RecordStats.java

+                for (Map.Entry<String, RecordPath> entry : paths.entrySet()) {
+                    RecordPathResult result = entry.getValue().evaluate(record);
+                    Optional<FieldValue> value = result.getSelectedFields().findFirst();
+                    if (value.isPresent() && value.get().getValue() != null) {


Why is fieldValue needed? There are a lot of *values in this loop.

I guess we can drop that.

ottobackwards · 2018-05-24T20:39:24Z

.../nifi-standard-processors/src/main/java/org/apache/nifi/processors/standard/RecordStats.java

+                }
+
+                recordCount++;
+            }


Magic Strings

"record_count" => constant field maybe?

not a biggie

MikeThomsen · 2018-06-02T20:06:15Z

@ijokarumawak can you review?

ijokarumawak

@MikeThomsen Thanks for adding this, this looks really useful! I haven't run it yet but looked through the code, and added few comments, as the first review cycle. Please check those out. Thanks!

ijokarumawak · 2018-06-04T02:12:25Z

.../nifi-standard-processors/src/main/java/org/apache/nifi/processors/standard/RecordStats.java

+        .name("record-stats-reader")
+        .displayName("Record Reader")
+        .description("A record reader to use for reading the records.")
+        .addValidator(Validator.VALID)


No validator is required for ControllerService.

ijokarumawak · 2018-06-04T02:32:13Z

.../nifi-standard-processors/src/main/java/org/apache/nifi/processors/standard/RecordStats.java

+                        String approxValue = value.get().getValue().toString();
+                        String key = String.format("%s.%s", entry.getKey(), approxValue);
+                        Integer stat = retVal.containsKey(key) ? retVal.get(key) : 0;
+                        Integer baseStat = retVal.containsKey(entry.getKey()) ? retVal.get(entry.getKey()) : 0;


Trivial, map.getOrDefault method can make these statement simpler.

ijokarumawak · 2018-06-04T03:05:47Z

.../nifi-standard-processors/src/main/java/org/apache/nifi/processors/standard/RecordStats.java

+                    RecordPathResult result = entry.getValue().evaluate(record);
+                    Optional<FieldValue> value = result.getSelectedFields().findFirst();
+                    if (value.isPresent() && value.get().getValue() != null) {
+                        String approxValue = value.get().getValue().toString();


Idea for improvement. If the RecordPath result is number, providing the counts based on value will be useful? Rather, I'd like to see in addition to counts (current baseStat), also min, max, sum and optionally sum of squared x.

Let's do that as a separate ticket if you don't mind.

Yes, we can add this later.

I hoped it will be included when this processor is released. Changing it after would require adding new configuration property. Well, that makes sense in some cases, too. E.g. if a number field represents some category information, or act as an enum, then user would expected the number of occurrence per the number value.

ijokarumawak · 2018-06-04T03:11:58Z

.../nifi-standard-processors/src/main/java/org/apache/nifi/processors/standard/RecordStats.java

+            return retVal.entrySet().stream()
+                .collect(Collectors.toMap(
+                    e -> e.getKey(),
+                    e -> e.getValue().toString()


For the non-number values, such as the 'sport' dataset, the list can be huge, order of thousands or more. That can be too big to store as FlowFile attributes. At lease we need a fixed number of attributes for this processor can add. It would be more helpful if we can limit the N number of values (i.e. soccer, football, basketball ... etc) and report the highest N variables, to report better stats with a long-tail dataset.

Ok. We can add a limit there.

ijokarumawak · 2018-06-05T00:20:09Z

@MikeThomsen Thanks for the updates. I will continue more close review on this when I have time, probably tomorrow.

MikeThomsen · 2018-06-07T12:41:03Z

@ijokarumawak Anything to add now or can we close this out?

ijokarumawak

@MikeThomsen I have built and test it locally. Posted several comments but I believe this would be the final review cycle before getting this merged. Thanks!

ijokarumawak · 2018-06-09T06:32:24Z

.../nifi-standard-processors/src/main/java/org/apache/nifi/processors/standard/RecordStats.java

+@WritesAttributes({
+    @WritesAttribute(attribute = RecordStats.RECORD_COUNT_ATTR, description = "A count of the records in the record set in the flowfile.")
+})
+public class RecordStats extends AbstractProcessor {


Since NiFi uses naming convention starting with a verve, this processor should be named such as 'CalcurateRecordStats' .

ijokarumawak · 2018-06-09T06:33:24Z

.../nifi-standard-processors/src/main/java/org/apache/nifi/processors/standard/RecordStats.java

+@WritesAttributes({
+    @WritesAttribute(attribute = RecordStats.RECORD_COUNT_ATTR, description = "A count of the records in the record set in the flowfile.")
+})
+public class RecordStats extends AbstractProcessor {


org.apache.nifi.processor.Processor file is not updated to use this new processor from NiFi flow.

ijokarumawak · 2018-06-09T06:41:49Z

.../nifi-standard-processors/src/main/java/org/apache/nifi/processors/standard/RecordStats.java

+        .displayName("Record Reader")
+        .description("A record reader to use for reading the records.")
+        .identifiesControllerService(RecordReaderFactory.class)
+        .build();


'Record Reader' should be required.

ijokarumawak · 2018-06-09T06:45:28Z

.../nifi-standard-processors/src/main/java/org/apache/nifi/processors/standard/RecordStats.java

+        "user-defined criteria on subsets of the record set.")
+@InputRequirement(InputRequirement.Requirement.INPUT_REQUIRED)
+@WritesAttributes({
+    @WritesAttribute(attribute = RecordStats.RECORD_COUNT_ATTR, description = "A count of the records in the record set in the flowfile.")


Please add recordStats.<User Defined Property Name>.count and recordStats.<User Defined Property Name>.count.<value>

Changed the names, but done.

ijokarumawak · 2018-06-09T06:50:19Z

...c/main/resources/docs/org.apache.nifi.processors.standard.RecordStats/additionalDetails.html

+        <li>record_count: 5</li>
+        <li>sport: 5</li>
+        <li>sport.Soccer: 3</li>
+        <li>sport.Football: 2</li>


These property names should be more self-descriptive and not to overlap other property name spaces.
I suggest following names:

current suggestion

record_count recordStats.count

sport recordStats.sport.count

sport.Soccer recordStats.sport.count.Soccer

sport.Football recordStats.sport.count.Football

Then we can add more stats later, such as recordStats.age.min or recordStats.age.max ... etc

ijokarumawak · 2018-06-09T06:58:34Z

.../nifi-standard-processors/src/main/java/org/apache/nifi/processors/standard/RecordStats.java

+
+    protected Map<String, RecordPath> getRecordPaths(ProcessContext context) {
+        return context.getProperties().keySet()
+            .stream().filter(p -> p.isDynamic() && !p.getName().contains(RECORD_READER.getName()))


I think !p.getName().contains(RECORD_READER.getName()) part is not necessary.

ijokarumawak · 2018-06-09T06:59:22Z

.../nifi-standard-processors/src/main/java/org/apache/nifi/processors/standard/RecordStats.java

+            .collect(Collectors.toMap(
+                e -> e.getName(),
+                e ->  {
+                    String val = context.getProperty(e).getValue();


I'd expect dynamic properties supports EL with FlowFile.

ijokarumawak · 2018-06-11T04:31:56Z

@MikeThomsen Thanks for the updates. LGTM, +1! Merging.

ijokarumawak · 2018-06-11T04:50:40Z

For future work, I've submitted this to add stats for numerical values.
https://issues.apache.org/jira/browse/NIFI-5291

MikeThomsen force-pushed the NIFI-5231 branch from 3bd9faa to ad3b7fe Compare May 24, 2018 13:11

NIFI-5231 Added RecordStats processor.

2cddeac

MikeThomsen force-pushed the NIFI-5231 branch from ad3b7fe to 2cddeac Compare May 24, 2018 13:52

ottobackwards reviewed May 24, 2018

View reviewed changes

MikeThomsen added 2 commits May 25, 2018 08:59

NIFI-5231 Minor fixes from code review.

db05aff

NIFI-5231 Added documentation and made record_count a constant.

5bbb723

ijokarumawak reviewed Jun 4, 2018

View reviewed changes

NIFI-5231 Added changes requested in a code review.

7461ab6

ijokarumawak requested changes Jun 9, 2018

View reviewed changes

NIFI-5231 Added changes based on code review.

dc1634d

asfgit closed this in 1803c15 Jun 11, 2018

MikeThomsen deleted the NIFI-5231 branch August 14, 2024 21:14

current	suggestion
record_count	recordStats.count
sport	recordStats.sport.count
sport.Soccer	recordStats.sport.count.Soccer
sport.Football	recordStats.sport.count.Football

NIFI-5231 Added RecordStats processor. #2737

NIFI-5231 Added RecordStats processor. #2737

Uh oh!

Conversation

MikeThomsen commented May 24, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

For all changes:

For code changes:

For documentation related changes:

Note:

Uh oh!

ottobackwards commented May 24, 2018

Uh oh!

MikeThomsen commented May 24, 2018

Uh oh!

ottobackwards commented May 24, 2018

Uh oh!

MikeThomsen commented May 24, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

ottobackwards commented May 24, 2018

Uh oh!

MikeThomsen commented May 24, 2018

Uh oh!

ottobackwards left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

MikeThomsen commented Jun 2, 2018

Uh oh!

ijokarumawak left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

ijokarumawak commented Jun 5, 2018

Uh oh!

MikeThomsen commented Jun 7, 2018

Uh oh!

ijokarumawak left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

MikeThomsen commented May 24, 2018 •

edited

Loading

MikeThomsen commented May 24, 2018 •

edited

Loading