[
https://issues.apache.org/jira/browse/NIFI-3392?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=15839059#comment-15839059
]
ASF GitHub Bot commented on NIFI-3392:
--------------------------------------
Github user alopresto commented on a diff in the pull request:
https://github.com/apache/nifi/pull/1445#discussion_r97922506
--- Diff: nifi-docs/src/main/asciidoc/user-guide.adoc ---
@@ -1690,11 +1687,36 @@ replay data at any point within the dataflow, and
see a graphical representation
image:provenance-annotated.png["Provenance Table"]
-Each point in a dataflow where a FlowFile is processed in some way is
considered a "processing event". Various types of processing
+[[provenance_events]]
+=== Provenance Events
+
+Each point in a dataflow where a FlowFile is processed in some way is
considered a 'provenance event'. Various types of provenance
events occur, depending on the dataflow design. For example, when data is
brought into the flow, a RECEIVE event occurs, and when
data is sent out of the flow, a SEND event occurs. Other types of
processing events may occur, such as if the data is cloned (CLONE event),
routed (ROUTE event), modified (CONTENT_MODIFIED or ATTRIBUTES_MODIFIED event),
split (FORK event), combined with other data objects (JOIN event), and
ultimately removed from the flow (DROP event).
+The provenance event types are:
+
+[options="header"]
+|======================
+|Provenance Event |Description
+|ADDINFO |Indicates a provenance event when additional
information such as a new linkage to a new URI or UUID is added
+|ATTRIBUTES_MODIFIED |Indicates that a FlowFile's attributes were
modified in some way
+|CLONE |Indicates that a FlowFile is an exact duplicate
of its parent FlowFile
+|CONTENT_MODIFIED |Indicates that a FlowFile's content was modified
in some way
+|CREATE |Indicates that a FlowFile was generated from
data that was not received from a remote system or external process
+|DOWNLOAD |Indicates that the contents of a FlowFile were
downloaded by a user or external entity
+|DROP |Indicates a provenance event for the conclusion
of an object's life for some reason other than object expiration
+|EXPIRE |Indicates a provenance event for the conclusion
of an object's life due to the object not being processed in a timely manner
+|FETCH |Indicates that the contents of a FlowFile were
overwritten using the contents of some external resource
+|FORK |Indicates that one or more FlowFiles were
derived from a parent FlowFile
+|JOIN |Indicates that a single FlowFile is derived from
joining together multiple parent FlowFiles
+|RECEIVE |Indicates a provenance event for receiving data
from an external process
+|REPLAY |Indicates a provenance event for replaying a
FlowFile.
--- End diff --
Removing unnecessary '.'.
> Enhance documentation for provenance event type definitions
> -----------------------------------------------------------
>
> Key: NIFI-3392
> URL: https://issues.apache.org/jira/browse/NIFI-3392
> Project: Apache NiFi
> Issue Type: Improvement
> Components: Documentation & Website
> Affects Versions: 1.1.1
> Reporter: Andy LoPresto
> Assignee: Andrew Lim
>
> The provenance events can be unfamiliar to new users, and the nuance of the
> event types can be confusing even to experienced users and developers. The
> documentation should be improved to contain a definition table of the various
> event types ({{CREATE}}, {{DROP}}, etc.), their meaning, and (for developers)
> when to use each type if writing their own provenance reporting code.
> A comprehensive list of event types is available (and discussed somewhat) in
> [{{ProvenanceEventType.java}}|https://github.com/apache/nifi/blob/master/nifi-api/src/main/java/org/apache/nifi/provenance/ProvenanceEventType.java].
>
--
This message was sent by Atlassian JIRA
(v6.3.4#6332)
