[jira] [Commented] (NIFI-4872) NIFI component high resource usage annotation

["ASF GitHub Bot (JIRA)" <ji...@apache.org>]

    [ https://issues.apache.org/jira/browse/NIFI-4872?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16382409#comment-16382409 ] 

ASF GitHub Bot commented on NIFI-4872:
--------------------------------------

Github user jtstorck commented on the issue:

    https://github.com/apache/nifi/pull/2475
  
    @markap14 I will add descriptions to the annotations for the processors you mentioned.  Thanks for the extra info!  We can do additional PRs to add more descriptions as needed, but I think the default descriptions are good to at least mark the current processors that might cause resource issues.
    
    As @joewitt mentioned, the annotation doesn't need to be used just to convey that a component might use a lot of a particular resource.  It can also include descriptions on how to best utilize the resources, or indicate that the component uses very little of a type of resource and can parallelized to a high degree without degrading system performance.  I can agree that currently, there aren't many components that would use the DISK or NETWORK SystemResource type when referring to how a single flowfile would affect them, but there may be in the future.  I think it's a good idea to keep all four types in the enumeration.  


> NIFI component high resource usage annotation
> ---------------------------------------------
>
>                 Key: NIFI-4872
>                 URL: https://issues.apache.org/jira/browse/NIFI-4872
>             Project: Apache NiFi
>          Issue Type: New Feature
>          Components: Core Framework, Core UI
>    Affects Versions: 1.5.0
>            Reporter: Jeff Storck
>            Assignee: Jeff Storck
>            Priority: Critical
>
> NiFi Processors currently have no means to relay whether or not they have may be resource intensive or not. The idea here would be to introduce an Annotation that can be added to Processors that indicate they may cause high memory, disk, CPU, or network usage. For instance, any Processor that reads the FlowFile contents into memory (like many XML Processors for instance) may cause high memory usage. What ultimately determines if there is high memory/disk/cpu/network usage will depend on the FlowFiles being processed. With many of these components in the dataflow, it increases the risk of OutOfMemoryErrors and performance degradation.
> The annotation should support one value from a fixed list of: CPU, Disk, Memory, Network.  It should also allow the developer to provide a custom description of the scenario that the component would fall under the high usage category.  The annotation should be able to be specified multiple times, for as many resources as it has the potential to be high usage.
> By marking components with this new Annotation, we can update the generated Processor documentation to include this fact.



--
This message was sent by Atlassian JIRA
(v7.6.3#76005)