markap14 opened a new pull request, #11914: URL: https://github.com/apache/nifi/pull/11914
<!-- Licensed to the Apache Software Foundation (ASF) under one or more --> <!-- contributor license agreements. See the NOTICE file distributed with --> <!-- this work for additional information regarding copyright ownership. --> <!-- The ASF licenses this file to You under the Apache License, Version 2.0 --> <!-- (the "License"); you may not use this file except in compliance with --> <!-- the License. You may obtain a copy of the License at --> <!-- http://www.apache.org/licenses/LICENSE-2.0 --> <!-- Unless required by applicable law or agreed to in writing, software --> <!-- distributed under the License is distributed on an "AS IS" BASIS, --> <!-- WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. --> <!-- See the License for the specific language governing permissions and --> <!-- limitations under the License. --> # Summary [NIFI-16575](https://issues.apache.org/jira/browse/NIFI-16575) This adds framework support for draining a Process Group, as proposed in [NIP-51](https://issues.apache.org/jira/browse/NIP-51). A drain stops the components that bring data into the group and runs everything else until the data already queued in the group has been processed. - **Framework:** a drain stops the source components of the group, enables the Controller Services that the Processors reference, starts the other components, and calls the `@OnDrainInitiated` and `@OnDrainCompleted` methods. While a drain is active, users cannot start the source components or stop the other components. A drain reports how much data is still queued and which components are keeping it from finishing. - **REST API:** new endpoints under `/process-groups/{id}/drain-requests` to begin, check, and cancel a drain, with support for clusters. `ProcessGroupDTO` gains a read-only `drainRequestId`. - **Connectors:** `StandaloneProcessGroupLifecycle` implements the new `beginDrain()` and `endDrain()` methods, so that a Connector drains its flow using the same code. - **Extensions:** MergeContent and MergeRecord use a short Max Bin Age while draining, so that partial bins are sent on rather than held until more data arrives. - **nifi-mock:** `TestRunner` gains `initiateDrain()` and `completeDrain()`. - **Documentation:** the Developer Guide describes the new lifecycle annotations and the `TestRunner` methods. This depends on [apache/nifi-api#115](https://github.com/apache/nifi-api/pull/115) and sets `nifi-api.version` to `2.17.0-SNAPSHOT`, so the build will not pass until that change is merged and published. The UI is tracked separately in [NIFI-16576](https://issues.apache.org/jira/browse/NIFI-16576). New system tests `ProcessGroupDrainIT` and `ClusteredProcessGroupDrainIT` cover draining on a single node and in a cluster, and `ConnectorDrainIT` now verifies that a Connector drain calls the drain lifecycle methods. # Tracking Please complete the following tracking steps prior to pull request creation. ### Issue Tracking - [x] [Apache NiFi Jira](https://issues.apache.org/jira/browse/NIFI) issue created ### Pull Request Tracking - [x] Pull Request title starts with Apache NiFi Jira issue number, such as `NIFI-00000` - [x] Pull Request commit message starts with Apache NiFi Jira issue number, as such `NIFI-00000` - [x] Pull request contains [commits signed](https://docs.github.com/en/authentication/managing-commit-signature-verification/signing-commits) with a registered key indicating `Verified` status ### Pull Request Formatting - [x] Pull Request based on current revision of the `main` branch - [x] 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 `./mvnw clean install -P contrib-check` - [ ] JDK 21 - [ ] JDK 25 ### Licensing - [ ] New dependencies are compatible with the [Apache License 2.0](https://apache.org/licenses/LICENSE-2.0) according to the [License Policy](https://www.apache.org/legal/resolved.html) - [ ] New dependencies are documented in applicable `LICENSE` and `NOTICE` files ### Documentation - [ ] Documentation formatting appears as expected in rendered files -- 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: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
