Nifi 8703

[Kerudal]

Thank you for submitting a contribution to Apache NiFi.

Please provide a short description of the PR here:

The objective of this issue is to bring to the community a new type of processor to enable the limitation of incoming traffic. Using a CacheBuilder from Guava and buckets from Bucket4j, this processor can read a bucket key from the record or the default value given by the attribute, and check if the rate limit is respected. You have several parameters to configure the rate limiter like, refill tokens, refill period, bandwidth capacity, max size bucket, and expire duration. All of which have specific descriptions reusing the apache documentation of the Bucket4j library.

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? Yes https://issues.apache.org/jira/browse/NIFI-8703

• 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 squash or use --force when pushing to allow for clean monitoring of changes.

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?
• Have you verified that the full build is successful on JDK 8?
• [x ] Have you verified that the full build is successful on JDK 11?
• 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 GitHub Actions CI for build issues and submit an update to your PR as soon as possible.

[joewitt]

Hello

Thanks for your contribution. On the initial commit for a PR you want to have a single commit rather than the full history it took to get here. This commit also reflects that there are rebase issues that will need to be resolved.

Also for such a processor you will want to ensure the naming scheme is followed. Instead of RateLimiter the processor name would be 'LimitRate' and 'LimitRecordRate'.

For each of the dependencies and their transitive dependencies are the licenses compatible with ASF projects? We will need to ensure proper licensing and notice information is provided.

Thanks

[joewitt]

You also want to make sure the git commit message indicates the correct JIRA entry. for this it should include 'NIFI-8703' instead of other variations/cases/etc.

[Kerudal]

Hello Joe,

Thank you for the clarification. Should I remove this contribution and do a new one with only one commit containing the JIRA name? (if yes, how do I remove this one ?) I will take this opportunity to change the name of the processors with the ones you gave me. As well as resolve rebase issues. I did check that all dependencies are under ASF project, they have an apache license. Where should this information be stored, in nifi-assembly ? Thank you for your help (I wasn't sure my commit was contributing the right way)

[github-actions]

We're marking this PR as stale due to lack of updates in the past few months. If after another couple of weeks the stale label has not been removed this PR will be closed. This stale marker and eventual auto close does not indicate a judgement of the PR just lack of reviewer bandwidth and helps us keep the PR queue more manageable. If you would like this PR re-opened you can do so and a committer can remove the stale tag. Or you can open a new PR. Try to help review other PRs to increase PR review bandwidth which in turn helps yours.