[GitHub] [nifi] exceptionfactory commented on a diff in pull request #6156: NIFI-10167: Added advanced timing metrics for processors, such as CPU…

[GitBox <gi...@apache.org>]

exceptionfactory commented on code in PR #6156:
URL: https://github.com/apache/nifi/pull/6156#discussion_r908767825


##########
nifi-commons/nifi-properties/src/main/java/org/apache/nifi/util/NiFiProperties.java:
##########
@@ -329,6 +329,12 @@ public class NiFiProperties extends ApplicationProperties {
     public static final int DEFAULT_DIAGNOSTICS_ON_SHUTDOWN_MAX_FILE_COUNT = 10;
     public static final String DEFAULT_DIAGNOSTICS_ON_SHUTDOWN_MAX_DIRECTORY_SIZE = "10 MB";
 
+    // performance tracking
+    public static final String TRACK_PERFORMANCE_PERCENTAGE = "nifi.performance.tracking.percentage";
+
+    // performance tracking defaults
+    public static final int DEFAULT_TRACK_PERFORMANCE_PERCENTAGE = 5;

Review Comment:
   Should this value be set to `0` to align with the default setting in `nifi.properties`? That should ensure this feature is disabled by default even in the absence of having the property defined.



##########
nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-resources/src/main/resources/conf/nifi.properties:
##########
@@ -345,6 +345,14 @@ nifi.diagnostics.on.shutdown.max.filecount=10
 # The diagnostics folder's maximum permitted size in bytes. If the limit is exceeded, the oldest files are deleted.
 nifi.diagnostics.on.shutdown.max.directory.size=10 MB
 
+# Performance tracking properties
+## Specifies what percentage of the time we should track the amount of time processors are using CPU, reading from/writing to content repo, etc.
+## This can be useful to understand which components are the most expensive and to understand where system bottlenecks may be occurring.
+## The value must be in the range of 0 (inclusive) to 100 (inclusive). A larger value will produce more accurate results, while a smaller value may be
+## less expensive to compute.
+## Results can be obtained by running "nifi.sh diagnostics <filename>" and then inspecting the produced file.
+nifi.performance.tracking.percentage=${nifi.performance.tracking.percentage}

Review Comment:
   It would be helpful to include this same information in the Administrator's Guide, perhaps under `Runtime Monitoring Properties` or `NiFi Diagnostics`. If it is specific to the `diagnostics` command, should the property be named `nifi.diagnostics.performance.tracking.percentage`?



-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: issues-unsubscribe@nifi.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org