Apache/nifi
1
0
Fork 0
mirror of https://github.com/apache/nifi.git synced 2025-02-09 11:35:05 +00:00
Code Issues Packages Projects Releases Wiki Activity

NIFI-11256 Improved documentation for Azure Event Hubs Processors

Browse Source 
- used the same ordering of 'Event Hub Namespace', 'Event Hub Name' and 'Service Bus Endpoint' properties
- removed "Primary" tag from 'Shared Access Policy Key' property name
- added some notes on clustering and consumer group in the documentation

This closes #7018

Signed-off-by: David Handermann <exceptionfactory@apache.org>
This commit is contained in:
Peter Turcsanyi 2023-03-07 16:15:27 +01:00 committed by exceptionfactory
parent 512155ba2f
commit 5088934b79
No known key found for this signature in database
GPG Key ID: 29B6A52D2AAE8DBA
4 changed files with 9 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
nifi-nar-bundles/nifi-azure-bundle/nifi-azure-processors/src/main/java/org/apache/nifi/processors/azure/eventhub/ConsumeAzureEventHub.java
View File

@ -88,7 +88,9 @@ import static org.apache.commons.lang3.StringUtils.defaultIfBlank;
@Tags({"azure", "microsoft", "cloud", "eventhub", "events", "streaming", "streams"})
@CapabilityDescription("Receives messages from Microsoft Azure Event Hubs with checkpointing to ensure consistent event processing. "
+ "Checkpoint tracking avoids consuming a message multiple times and enables reliable resumption of processing in the event of intermittent network failures. "
+ "Checkpoint tracking requires external storage and provides the preferred approach to consuming messages from Azure Event Hubs.")
+ "Checkpoint tracking requires external storage and provides the preferred approach to consuming messages from Azure Event Hubs. "
+ "In clustered environment, ConsumeAzureEventHub processor instances form a consumer group and the messages are distributed among the cluster nodes "
+ "(each message is processed on one cluster node only).")
@InputRequirement(InputRequirement.Requirement.INPUT_FORBIDDEN)
@TriggerSerially
@WritesAttributes({

4
nifi-nar-bundles/nifi-azure-bundle/nifi-azure-processors/src/main/java/org/apache/nifi/processors/azure/eventhub/GetAzureEventHub.java
View File

@ -66,6 +66,8 @@ 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 without reliable checkpoint tracking. "
+ "In clustered environment, GetAzureEventHub processor instances work independently and all cluster nodes process all messages "
+ "(unless running the processor in Primary Only mode). "
+ "ConsumeAzureEventHub offers the recommended approach to receiving messages from Azure Event Hubs. "
+ "This processor creates a thread pool for connections to Azure Event Hubs.")
@InputRequirement(Requirement.INPUT_FORBIDDEN)
@ -161,9 +163,9 @@ public class GetAzureEventHub extends AbstractProcessor {
static {
propertyDescriptors = Collections.unmodifiableList(Arrays.asList(
NAMESPACE,
EVENT_HUB_NAME,
SERVICE_BUS_ENDPOINT,
NAMESPACE,
ACCESS_POLICY,
POLICY_PRIMARY_KEY,
USE_MANAGED_IDENTITY,

2
nifi-nar-bundles/nifi-azure-bundle/nifi-azure-processors/src/main/java/org/apache/nifi/processors/azure/eventhub/PutAzureEventHub.java
View File

@ -124,8 +124,8 @@ public class PutAzureEventHub extends AbstractProcessor {
static {
final List<PropertyDescriptor> configuredDescriptors = new ArrayList<>();
configuredDescriptors.add(EVENT_HUB_NAME);
configuredDescriptors.add(NAMESPACE);
configuredDescriptors.add(EVENT_HUB_NAME);
configuredDescriptors.add(SERVICE_BUS_ENDPOINT);
configuredDescriptors.add(ACCESS_POLICY);
configuredDescriptors.add(POLICY_PRIMARY_KEY);

3
nifi-nar-bundles/nifi-azure-bundle/nifi-azure-processors/src/main/java/org/apache/nifi/processors/azure/eventhub/utils/AzureEventHubUtils.java
View File

@ -37,7 +37,8 @@ public final class AzureEventHubUtils {
public static final PropertyDescriptor POLICY_PRIMARY_KEY = new PropertyDescriptor.Builder()
.name("Shared Access Policy Primary Key")
.description("The primary key of the shared access policy")
.displayName("Shared Access Policy Key")
.description("The key of the shared access policy. Either the primary or the secondary key can be used.")
.addValidator(StandardValidators.NON_EMPTY_VALIDATOR)
.expressionLanguageSupported(ExpressionLanguageScope.NONE)
.sensitive(true)