You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@nifi.apache.org by GitBox <gi...@apache.org> on 2021/09/14 13:25:41 UTC

[GitHub] [nifi] greyp9 opened a new pull request #5386: NIFI-9212 - tweak netty shutdown config

greyp9 opened a new pull request #5386:
URL: https://github.com/apache/nifi/pull/5386


   <!--
     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.
   -->
   Thank you for submitting a contribution to Apache NiFi.
   
   Please provide a short description of the PR here:
   
   #### Description of PR
   
   Provide ability to adjust the shutdown configuration of NettyEventSender and NettyEventServer.  Adjust JUnit tests to reduce the amount of time needed to tear down netty connections.
   
   In order to streamline the review of the contribution we ask you
   to ensure the following steps have been taken:
   
   ### For all changes:
   - [x] Is there a JIRA ticket associated with this PR? Is it referenced 
        in the commit message?
   
   - [x] 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`)?
   
   - [x] 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:
   - [x] Have you ensured that the full suite of tests is executed via `mvn -Pcontrib-check clean install` at the root `nifi` folder?
   - [x] Have you written or updated unit tests to verify your changes?
   - [x] 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](http://www.apache.org/legal/resolved.html#category-a)? 
   - [ ] 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.
   


-- 
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



[GitHub] [nifi] exceptionfactory commented on a change in pull request #5386: NIFI-9212 - tweak netty shutdown config

Posted by GitBox <gi...@apache.org>.
exceptionfactory commented on a change in pull request #5386:
URL: https://github.com/apache/nifi/pull/5386#discussion_r709479368



##########
File path: nifi-nar-bundles/nifi-extension-utils/nifi-event-transport/src/main/java/org/apache/nifi/event/transport/configuration/ShutdownTimeout.java
##########
@@ -0,0 +1,34 @@
+/*
+ * 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.
+ */
+package org.apache.nifi.event.transport.configuration;
+
+import java.time.Duration;
+
+public enum ShutdownTimeout {
+    QUICK(Duration.ofMillis(5000)),
+    DEFAULT(Duration.ofMillis(15000));
+
+    private final Duration value;
+
+    ShutdownTimeout(final Duration value) {
+        this.value = value;
+    }
+
+    public Duration value() {

Review comment:
       Recommend renaming this to `getDuration()` along with the `value` property.




-- 
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



[GitHub] [nifi] greyp9 commented on a change in pull request #5386: NIFI-9212 - tweak netty shutdown config

Posted by GitBox <gi...@apache.org>.
greyp9 commented on a change in pull request #5386:
URL: https://github.com/apache/nifi/pull/5386#discussion_r708730096



##########
File path: nifi-nar-bundles/nifi-extension-utils/nifi-event-transport/src/main/java/org/apache/nifi/event/transport/netty/NettyEventSender.java
##########
@@ -25,20 +25,31 @@
 import org.apache.nifi.event.transport.EventSender;
 
 import java.net.SocketAddress;
+import java.util.concurrent.TimeUnit;
 
 /**
  * Netty Event Sender with Channel Pool
  *
  * @param <T> Event Type
  */
 class NettyEventSender<T> implements EventSender<T> {
+    static final long SHUTDOWN_QUIET_PERIOD = 2000;  // netty default
+    static final long SHUTDOWN_TIMEOUT = 15000;  // netty default
+    static final TimeUnit SHUTDOWN_TIME_UNIT = TimeUnit.MILLISECONDS;
+
     private final EventLoopGroup group;
 
     private final ChannelPool channelPool;
 
     private final SocketAddress remoteAddress;
 
-    private boolean singleEventPerConnection;
+    private final boolean singleEventPerConnection;
+
+    private final long shutdownQuietPeriod;
+
+    private final long shutdownTimeout;
+
+    private final TimeUnit shutdownTimeUnit;

Review comment:
       I was originally modeling after the netty API.  But this suggestion does reduce the complexity; thanks. 




-- 
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



[GitHub] [nifi] asfgit closed pull request #5386: NIFI-9212 - tweak netty shutdown config

Posted by GitBox <gi...@apache.org>.
asfgit closed pull request #5386:
URL: https://github.com/apache/nifi/pull/5386


   


-- 
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



[GitHub] [nifi] exceptionfactory commented on a change in pull request #5386: NIFI-9212 - tweak netty shutdown config

Posted by GitBox <gi...@apache.org>.
exceptionfactory commented on a change in pull request #5386:
URL: https://github.com/apache/nifi/pull/5386#discussion_r709479591



##########
File path: nifi-nar-bundles/nifi-extension-utils/nifi-event-transport/src/main/java/org/apache/nifi/event/transport/configuration/ShutdownQuietPeriod.java
##########
@@ -0,0 +1,34 @@
+/*
+ * 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.
+ */
+package org.apache.nifi.event.transport.configuration;
+
+import java.time.Duration;
+
+public enum ShutdownQuietPeriod {
+    QUICK(Duration.ofMillis(100)),
+    DEFAULT(Duration.ofMillis(2000));
+
+    private final Duration value;
+
+    ShutdownQuietPeriod(final Duration value) {
+        this.value = value;
+    }
+
+    public Duration value() {

Review comment:
       As noted on `ShutdownTimeout`, recommend renaming this to `getDuration()`.




-- 
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



[GitHub] [nifi] greyp9 commented on a change in pull request #5386: NIFI-9212 - tweak netty shutdown config

Posted by GitBox <gi...@apache.org>.
greyp9 commented on a change in pull request #5386:
URL: https://github.com/apache/nifi/pull/5386#discussion_r709650143



##########
File path: nifi-nar-bundles/nifi-extension-utils/nifi-event-transport/src/main/java/org/apache/nifi/event/transport/configuration/ShutdownTimeout.java
##########
@@ -0,0 +1,34 @@
+/*
+ * 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.
+ */
+package org.apache.nifi.event.transport.configuration;
+
+import java.time.Duration;
+
+public enum ShutdownTimeout {
+    QUICK(Duration.ofMillis(5000)),
+    DEFAULT(Duration.ofMillis(15000));
+
+    private final Duration value;
+
+    ShutdownTimeout(final Duration value) {
+        this.value = value;
+    }
+
+    public Duration value() {

Review comment:
       renamed




-- 
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



[GitHub] [nifi] greyp9 commented on a change in pull request #5386: NIFI-9212 - tweak netty shutdown config

Posted by GitBox <gi...@apache.org>.
greyp9 commented on a change in pull request #5386:
URL: https://github.com/apache/nifi/pull/5386#discussion_r709457887



##########
File path: nifi-nar-bundles/nifi-extension-utils/nifi-event-transport/src/main/java/org/apache/nifi/event/transport/netty/NettyEventServer.java
##########
@@ -20,23 +20,52 @@
 import io.netty.channel.EventLoopGroup;
 import org.apache.nifi.event.transport.EventServer;
 
+import java.util.concurrent.TimeUnit;
+
 /**
  * Netty Event Server
  */
 class NettyEventServer implements EventServer {
+    static final long SHUTDOWN_QUIET_PERIOD = 2000;  // netty default
+    static final long SHUTDOWN_TIMEOUT = 15000;  // netty default
+    static final TimeUnit SHUTDOWN_TIME_UNIT = TimeUnit.MILLISECONDS;

Review comment:
       Added enums for quiet period and for timeout.




-- 
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



[GitHub] [nifi] exceptionfactory commented on a change in pull request #5386: NIFI-9212 - tweak netty shutdown config

Posted by GitBox <gi...@apache.org>.
exceptionfactory commented on a change in pull request #5386:
URL: https://github.com/apache/nifi/pull/5386#discussion_r708600644



##########
File path: nifi-nar-bundles/nifi-extension-utils/nifi-event-transport/src/main/java/org/apache/nifi/event/transport/netty/NettyEventServer.java
##########
@@ -20,23 +20,52 @@
 import io.netty.channel.EventLoopGroup;
 import org.apache.nifi.event.transport.EventServer;
 
+import java.util.concurrent.TimeUnit;
+
 /**
  * Netty Event Server
  */
 class NettyEventServer implements EventServer {
+    static final long SHUTDOWN_QUIET_PERIOD = 2000;  // netty default
+    static final long SHUTDOWN_TIMEOUT = 15000;  // netty default
+    static final TimeUnit SHUTDOWN_TIME_UNIT = TimeUnit.MILLISECONDS;

Review comment:
       In light of the duplication of these properties between `NettyEventSender` and `NettyEventServer`, it seems like they should be refactored to a shared location. Perhaps an `enum` named something like `ShutdownDuration` with `TIMEOUT` and `QUIET_PERIOD` properties?

##########
File path: nifi-nar-bundles/nifi-extension-utils/nifi-event-transport/src/main/java/org/apache/nifi/event/transport/netty/NettyEventSender.java
##########
@@ -25,20 +25,31 @@
 import org.apache.nifi.event.transport.EventSender;
 
 import java.net.SocketAddress;
+import java.util.concurrent.TimeUnit;
 
 /**
  * Netty Event Sender with Channel Pool
  *
  * @param <T> Event Type
  */
 class NettyEventSender<T> implements EventSender<T> {
+    static final long SHUTDOWN_QUIET_PERIOD = 2000;  // netty default
+    static final long SHUTDOWN_TIMEOUT = 15000;  // netty default
+    static final TimeUnit SHUTDOWN_TIME_UNIT = TimeUnit.MILLISECONDS;
+
     private final EventLoopGroup group;
 
     private final ChannelPool channelPool;
 
     private final SocketAddress remoteAddress;
 
-    private boolean singleEventPerConnection;
+    private final boolean singleEventPerConnection;
+
+    private final long shutdownQuietPeriod;
+
+    private final long shutdownTimeout;
+
+    private final TimeUnit shutdownTimeUnit;

Review comment:
       Rather than having separate properties, it seems like the implementation could be streamlined using `java.time.Duration`.  This would remove the need for the `shutdownTimeUnit` property.




-- 
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



[GitHub] [nifi] greyp9 commented on a change in pull request #5386: NIFI-9212 - tweak netty shutdown config

Posted by GitBox <gi...@apache.org>.
greyp9 commented on a change in pull request #5386:
URL: https://github.com/apache/nifi/pull/5386#discussion_r709650194



##########
File path: nifi-nar-bundles/nifi-extension-utils/nifi-event-transport/src/main/java/org/apache/nifi/event/transport/configuration/ShutdownQuietPeriod.java
##########
@@ -0,0 +1,34 @@
+/*
+ * 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.
+ */
+package org.apache.nifi.event.transport.configuration;
+
+import java.time.Duration;
+
+public enum ShutdownQuietPeriod {
+    QUICK(Duration.ofMillis(100)),
+    DEFAULT(Duration.ofMillis(2000));
+
+    private final Duration value;
+
+    ShutdownQuietPeriod(final Duration value) {
+        this.value = value;
+    }
+
+    public Duration value() {

Review comment:
       renamed




-- 
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