doc: Group Similar Errors property in EmailProvenanceReporter (#70)

easy-global-market · Sep 19, 2024 · eef310b · eef310b
1 parent c34a84c
commit eef310b
Show file tree

Hide file tree

Showing 2 changed files with 2 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -77,6 +77,8 @@ Reporting task to send provenance events considered as errors by email.
 
 * `Email Subject Prefix` is a property that contains a prefix to be added in the email subject. It can be for example the NiFi instance the error is coming from (optional).
 * `Specific Recipient Attribute Name` is a property that contains a flow file attribute name whose value will be used as an extra recipient email address when sending the email alert (optional).
+* `Group Similar Errors` is a property that specifies whether to group similar error events into a single email or not. The grouping is done by processor id and error information (event type and details).
+When set to `true` a single email with grouped errors will be sent. When set to `false` an email for each error will be sent (optional).
 
 ## Todo
 

diff --git a/docs/images/email-reporting-task-properties.png b/docs/images/email-reporting-task-properties.png