You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@nifi.apache.org by "dam4rus (via GitHub)" <gi...@apache.org> on 2023/03/03 08:26:38 UTC
[GitHub] [nifi] dam4rus opened a new pull request, #7006: NIFI-11246 Document differences between GetAzureEventHub and ConsumeA…
dam4rus opened a new pull request, #7006:
URL: https://github.com/apache/nifi/pull/7006
…zureEventHub
<!-- 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-00000](https://issues.apache.org/jira/browse/NIFI-00000)
# 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`
### 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 `mvn clean install -P contrib-check`
- [ ] JDK 11
- [x] JDK 17
### Licensing
- [x] 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)
- [x] New dependencies are documented in applicable `LICENSE` and `NOTICE` files
### Documentation
- [x] 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: issues-unsubscribe@nifi.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [nifi] exceptionfactory closed pull request #7006: NIFI-11246 Document differences between GetAzureEventHub and ConsumeA…
Posted by "exceptionfactory (via GitHub)" <gi...@apache.org>.
exceptionfactory closed pull request #7006: NIFI-11246 Document differences between GetAzureEventHub and ConsumeA…
URL: https://github.com/apache/nifi/pull/7006
--
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] dam4rus commented on a diff in pull request #7006: NIFI-11246 Document differences between GetAzureEventHub and ConsumeA…
Posted by "dam4rus (via GitHub)" <gi...@apache.org>.
dam4rus commented on code in PR #7006:
URL: https://github.com/apache/nifi/pull/7006#discussion_r1126022538
##########
nifi-nar-bundles/nifi-azure-bundle/nifi-azure-processors/src/main/java/org/apache/nifi/processors/azure/eventhub/GetAzureEventHub.java:
##########
@@ -64,8 +64,12 @@
import org.apache.nifi.processors.azure.eventhub.utils.AzureEventHubUtils;
@Tags({"azure", "microsoft", "cloud", "eventhub", "events", "streaming", "streams"})
-@CapabilityDescription("Receives messages from Microsoft Azure Event Hubs, writing the contents of the Azure message to the content of the FlowFile. "
- + "Note: Please be aware that this processor creates a thread pool of 4 threads for Event Hub Client. They will be extra threads other than the concurrent tasks scheduled for this processor.")
+@CapabilityDescription("Receives messages from Microsoft Azure Event Hubs, writing the contents of the message to the content of the FlowFile. "
Review Comment:
I've swapped the two sentences because it felt strange that the first sentence is not about GetAzureEventHub in the documentation of the said processor.
--
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 diff in pull request #7006: NIFI-11246 Document differences between GetAzureEventHub and ConsumeA…
Posted by "exceptionfactory (via GitHub)" <gi...@apache.org>.
exceptionfactory commented on code in PR #7006:
URL: https://github.com/apache/nifi/pull/7006#discussion_r1124479716
##########
nifi-nar-bundles/nifi-azure-bundle/nifi-azure-processors/src/main/java/org/apache/nifi/processors/azure/eventhub/ConsumeAzureEventHub.java:
##########
@@ -86,7 +86,10 @@
import static org.apache.commons.lang3.StringUtils.defaultIfBlank;
@Tags({"azure", "microsoft", "cloud", "eventhub", "events", "streaming", "streams"})
-@CapabilityDescription("Receives messages from Azure Event Hubs, writing the contents of the message to the content of the FlowFile.")
+@CapabilityDescription("Receives messages from Microsoft Azure Event Hubs, writing the contents of the message to the content of the FlowFile. "
+ + "This processor shares the same functionality as GetAzureEventHub but supports checkpoints via Azure Blob Storage. "
+ + "Using checkpoints eliminates the chance of consuming a message multiple times. "
Review Comment:
Recommend adjusting the wording to mention additional benefits.
```suggestion
+ "Checkpoint tracking avoids consuming a message multiple times and enables reliable resumption of processing in the event of intermittent network failures. "
```
##########
nifi-nar-bundles/nifi-azure-bundle/nifi-azure-processors/src/main/java/org/apache/nifi/processors/azure/eventhub/GetAzureEventHub.java:
##########
@@ -64,8 +64,12 @@
import org.apache.nifi.processors.azure.eventhub.utils.AzureEventHubUtils;
@Tags({"azure", "microsoft", "cloud", "eventhub", "events", "streaming", "streams"})
-@CapabilityDescription("Receives messages from Microsoft Azure Event Hubs, writing the contents of the Azure message to the content of the FlowFile. "
- + "Note: Please be aware that this processor creates a thread pool of 4 threads for Event Hub Client. They will be extra threads other than the concurrent tasks scheduled for this processor.")
+@CapabilityDescription("Receives messages from Microsoft Azure Event Hubs, writing the contents of the message to the content of the FlowFile. "
+ + "Note: Please be aware that this processor creates a thread pool for Event Hub Client. "
+ + "They will be extra threads other than the concurrent tasks scheduled for this processor. "
+ + "Please also be aware that this processor does not support checkpoints. "
+ + "Meaning there is no way to continue receiving messages from a certain offset after the processor has been stopped, "
+ + "which can lead to data duplication. It is recommended to use ConsumeAzureEventHub instead if possible.")
Review Comment:
With the suggested rewording in the first sentence, recommend the following changes:
```suggestion
+ "Lack of message checkpointing in GetAzureEventHub can result in data loss or data duplication depending on scheduling settings.")
```
##########
nifi-nar-bundles/nifi-azure-bundle/nifi-azure-processors/src/main/java/org/apache/nifi/processors/azure/eventhub/GetAzureEventHub.java:
##########
@@ -64,8 +64,12 @@
import org.apache.nifi.processors.azure.eventhub.utils.AzureEventHubUtils;
@Tags({"azure", "microsoft", "cloud", "eventhub", "events", "streaming", "streams"})
-@CapabilityDescription("Receives messages from Microsoft Azure Event Hubs, writing the contents of the Azure message to the content of the FlowFile. "
- + "Note: Please be aware that this processor creates a thread pool of 4 threads for Event Hub Client. They will be extra threads other than the concurrent tasks scheduled for this processor.")
+@CapabilityDescription("Receives messages from Microsoft Azure Event Hubs, writing the contents of the message to the content of the FlowFile. "
+ + "Note: Please be aware that this processor creates a thread pool for Event Hub Client. "
Review Comment:
The `Note` prefix can be removed.
```suggestion
+ "This processor creates a thread pool for connections to Azure Event Hubs. "
```
##########
nifi-nar-bundles/nifi-azure-bundle/nifi-azure-processors/src/main/java/org/apache/nifi/processors/azure/eventhub/ConsumeAzureEventHub.java:
##########
@@ -86,7 +86,10 @@
import static org.apache.commons.lang3.StringUtils.defaultIfBlank;
@Tags({"azure", "microsoft", "cloud", "eventhub", "events", "streaming", "streams"})
-@CapabilityDescription("Receives messages from Azure Event Hubs, writing the contents of the message to the content of the FlowFile.")
+@CapabilityDescription("Receives messages from Microsoft Azure Event Hubs, writing the contents of the message to the content of the FlowFile. "
+ + "This processor shares the same functionality as GetAzureEventHub but supports checkpoints via Azure Blob Storage. "
+ + "Using checkpoints eliminates the chance of consuming a message multiple times. "
+ + "Hence, this is the preferred way to consume Azure Event Hubs messages if Azure Blob Storage is available.")
Review Comment:
```suggestion
+ "Checkpoint tracking requires external storage and provides the preferred approach to consuming messages from Azure Event Hubs.")
```
##########
nifi-nar-bundles/nifi-azure-bundle/nifi-azure-processors/src/main/java/org/apache/nifi/processors/azure/eventhub/ConsumeAzureEventHub.java:
##########
@@ -86,7 +86,10 @@
import static org.apache.commons.lang3.StringUtils.defaultIfBlank;
@Tags({"azure", "microsoft", "cloud", "eventhub", "events", "streaming", "streams"})
-@CapabilityDescription("Receives messages from Azure Event Hubs, writing the contents of the message to the content of the FlowFile.")
+@CapabilityDescription("Receives messages from Microsoft Azure Event Hubs, writing the contents of the message to the content of the FlowFile. "
+ + "This processor shares the same functionality as GetAzureEventHub but supports checkpoints via Azure Blob Storage. "
Review Comment:
As the preferred approach, the initial description should not be defined in terms of similarity to `GetAzureEventHub`. Recommend the following wording for the first sentence:
```suggestion
+ "Receives messages from Microsoft Azure Event Hubs with checkpointing to ensure consistent event processing. "
```
##########
nifi-nar-bundles/nifi-azure-bundle/nifi-azure-processors/src/main/java/org/apache/nifi/processors/azure/eventhub/GetAzureEventHub.java:
##########
@@ -64,8 +64,12 @@
import org.apache.nifi.processors.azure.eventhub.utils.AzureEventHubUtils;
@Tags({"azure", "microsoft", "cloud", "eventhub", "events", "streaming", "streams"})
-@CapabilityDescription("Receives messages from Microsoft Azure Event Hubs, writing the contents of the Azure message to the content of the FlowFile. "
- + "Note: Please be aware that this processor creates a thread pool of 4 threads for Event Hub Client. They will be extra threads other than the concurrent tasks scheduled for this processor.")
+@CapabilityDescription("Receives messages from Microsoft Azure Event Hubs, writing the contents of the message to the content of the FlowFile. "
+ + "Note: Please be aware that this processor creates a thread pool for Event Hub Client. "
+ + "They will be extra threads other than the concurrent tasks scheduled for this processor. "
+ + "Please also be aware that this processor does not support checkpoints. "
Review Comment:
With the above rewording, these two sentences can be removed.
```suggestion
```
##########
nifi-nar-bundles/nifi-azure-bundle/nifi-azure-processors/src/main/java/org/apache/nifi/processors/azure/eventhub/GetAzureEventHub.java:
##########
@@ -64,8 +64,12 @@
import org.apache.nifi.processors.azure.eventhub.utils.AzureEventHubUtils;
@Tags({"azure", "microsoft", "cloud", "eventhub", "events", "streaming", "streams"})
-@CapabilityDescription("Receives messages from Microsoft Azure Event Hubs, writing the contents of the Azure message to the content of the FlowFile. "
- + "Note: Please be aware that this processor creates a thread pool of 4 threads for Event Hub Client. They will be extra threads other than the concurrent tasks scheduled for this processor.")
+@CapabilityDescription("Receives messages from Microsoft Azure Event Hubs, writing the contents of the message to the content of the FlowFile. "
+ + "Note: Please be aware that this processor creates a thread pool for Event Hub Client. "
+ + "They will be extra threads other than the concurrent tasks scheduled for this processor. "
+ + "Please also be aware that this processor does not support checkpoints. "
+ + "Meaning there is no way to continue receiving messages from a certain offset after the processor has been stopped, "
+ + "which can lead to data duplication. It is recommended to use ConsumeAzureEventHub instead if possible.")
@InputRequirement(Requirement.INPUT_FORBIDDEN)
Review Comment:
Recommend adding the `@SeeAlso` annotation referencing `ConsumeAzureEventHub`.
##########
nifi-nar-bundles/nifi-azure-bundle/nifi-azure-processors/src/main/java/org/apache/nifi/processors/azure/eventhub/GetAzureEventHub.java:
##########
@@ -64,8 +64,12 @@
import org.apache.nifi.processors.azure.eventhub.utils.AzureEventHubUtils;
@Tags({"azure", "microsoft", "cloud", "eventhub", "events", "streaming", "streams"})
-@CapabilityDescription("Receives messages from Microsoft Azure Event Hubs, writing the contents of the Azure message to the content of the FlowFile. "
- + "Note: Please be aware that this processor creates a thread pool of 4 threads for Event Hub Client. They will be extra threads other than the concurrent tasks scheduled for this processor.")
+@CapabilityDescription("Receives messages from Microsoft Azure Event Hubs, writing the contents of the message to the content of the FlowFile. "
Review Comment:
```suggestion
@CapabilityDescription("ConsumeAzureEventHub offers the recommended approach to receiving messages from Azure Event Hubs. GetAzureEventHub receives messages from Microsoft Azure Event Hubs without reliable checkpoint tracking. "
```
--
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] dam4rus commented on pull request #7006: NIFI-11246 Document differences between GetAzureEventHub and ConsumeA…
Posted by "dam4rus (via GitHub)" <gi...@apache.org>.
dam4rus commented on PR #7006:
URL: https://github.com/apache/nifi/pull/7006#issuecomment-1455575887
Thanks @exceptionfactory for the review! I've updated the documentation based on your comments
--
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