Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

NIFI-12242: Added ability to route data that exceeds the configured t… #7895

Closed
wants to merge 2 commits into from

Conversation

markap14
Copy link
Contributor

…hreshold in ControlRate to be routed to 'rate exceeded' instead of just staying in the queue. Added Use Case documentation to ControlRate.

Summary

NIFI-00000

Tracking

Please complete the following tracking steps prior to pull request creation.

Issue Tracking

Pull Request Tracking

  • Pull Request title starts with Apache NiFi Jira issue number, such as NIFI-00000
  • Pull Request commit message starts with Apache NiFi Jira issue number, as such NIFI-00000

Pull Request Formatting

  • Pull Request based on current revision of the main branch
  • Pull Request refers to a feature branch with one commit containing changes

Verification

Please indicate the verification steps performed prior to pull request creation.

Build

  • Build completed using mvn clean install -P contrib-check
    • JDK 21

Licensing

  • New dependencies are compatible with the Apache License 2.0 according to the License Policy
  • New dependencies are documented in applicable LICENSE and NOTICE files

Documentation

  • Documentation formatting appears as expected in rendered files

…hreshold in ControlRate to be routed to 'rate exceeded' instead of just staying in the queue. Added Use Case documentation to ControlRate.
@markap14 markap14 added the hacktoberfest-accepted Hacktoberfest Accepted label Oct 18, 2023
@mosermw
Copy link
Member

mosermw commented Oct 19, 2023

reviewing

Copy link
Member

@mosermw mosermw left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just a couple documentation comments, the rest of the code looks good. I tested the logic in running NiFi and the new options and relationships work as expected.

For example, to allow through 8 MB per second, "Maximum Rate" to `8 MB`.
"""
)
@UseCase(description = "Limit the rate at which requests are sent to a downstream system with little to no bursts",
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

For this UseCase, would you change the word "requests" to "flowfiles"? (there are 3 places). That would make this UseCase generic for users that don't equate a request to a flowfile. The last 2 UseCases use the word "requests" which is fine for those cases.

Set the "Time Duration" property to `1 sec`.
Configure the "Maximum Rate" property to specify how much data should be allowed through each second.

For example, to allow through 8 MB per second, "Maximum Rate" to `8 MB`.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Missing word "set" e.g. "set Maximum Rate to '8 MB'". The word "set" is also missing in UseCase 3 and 4.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good catch @mosermw thanks

@markap14
Copy link
Contributor Author

Thanks @mosermw pushed a commit that addresses the above.

@mosermw
Copy link
Member

mosermw commented Oct 20, 2023

+1 merging to main

@asfgit asfgit closed this in 40ac38d Oct 20, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
hacktoberfest-accepted Hacktoberfest Accepted
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants