NIFI-8356: Add unit test for LongRunningTaskMonitor.#4925
NIFI-8356: Add unit test for LongRunningTaskMonitor.#4925turcsanyip wants to merge 1 commit intoapache:mainfrom
Conversation
exceptionfactory
left a comment
There was a problem hiding this comment.
Thanks for adding the unit test @turcsanyip! This covers all the bases, but what do you think about simplifying it to verify calling EventReporter and leave out verification of logging? That seems to be a good balance of verification without expecting specific logging statements.
| getLogger().info("Active threads: {}; Long running threads: {}", activeThreadCount, longRunningThreadCount); | ||
| } | ||
|
|
||
| @VisibleForTesting |
There was a problem hiding this comment.
Is it necessary to introduce testing for log statements? Testing the invocation of EventReport.reportEvent() seems sufficient since that is the primary purpose of the monitor. Avoiding evaluating of logging in the unit test removes the need for exposing these methods for testing purposes.
There was a problem hiding this comment.
The main purpose of this class to log info about long running (possible stuck) tasks in the nifi log file to make troubleshooting easier. The nifi log is the only persistent storage of these messages because the bulletins disappear after a while. That's why I would assert these statements.
Additionally, the messages are shown on the UI in two places: controller and processor level bulletins. EventReport.reportEvent() handles the controller level bulletin but the processor level bulletin is triggered by log items written by the processors logger. That's why we need assert that log call.
Asserting the last "Active threads:" summary log may be unnecessary but after checking the other logs I added it too.
There was a problem hiding this comment.
Thanks for the explanation @turcsanyip, that makes sense.
exceptionfactory
left a comment
There was a problem hiding this comment.
+1 Thanks @turcsanyip!
This closes apache#4925 Signed-off-by: David Handermann <exceptionfactory@apache.org>
https://issues.apache.org/jira/browse/NIFI-8356
Thank you for submitting a contribution to Apache NiFi.
Please provide a short description of the PR here:
Description of PR
Enables X functionality; fixes bug NIFI-YYYY.
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
main)?Is your initial contribution a single, squashed commit? Additional commits in response to PR reviewer feedback should be made on this branch and pushed to allow change tracking. Do not
squashor use--forcewhen pushing to allow for clean monitoring of changes.For code changes:
mvn -Pcontrib-check clean installat the rootnififolder?LICENSEfile, including the mainLICENSEfile undernifi-assembly?NOTICEfile, including the mainNOTICEfile found undernifi-assembly?.displayNamein addition to .name (programmatic access) for each of the new properties?For documentation related changes:
Note:
Please ensure that once the PR is submitted, you check GitHub Actions CI for build issues and submit an update to your PR as soon as possible.