You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@nifi.apache.org by andrewmlim <gi...@git.apache.org> on 2017/01/25 16:47:33 UTC
[GitHub] nifi pull request #1445: NIFI-3392 Enhance documentation for provenance even...
GitHub user andrewmlim opened a pull request:
https://github.com/apache/nifi/pull/1445
NIFI-3392 Enhance documentation for provenance event type definitions
Added new "Provenance Events" sections to User and Dev Guides. Made a minor edit in Admin guide for consistent use of "Provenance events".
You can merge this pull request into a Git repository by running:
$ git pull https://github.com/andrewmlim/nifi NIFI-3392
Alternatively you can review and apply these changes as the patch at:
https://github.com/apache/nifi/pull/1445.patch
To close this pull request, make a commit to your master/trunk branch
with (at least) the following in the commit message:
This closes #1445
----
commit bd9eb0ac6009845de9d5a34bd5384ade1945befd
Author: Andrew Lim <an...@gmail.com>
Date: 2017-01-25T16:44:40Z
NIFI-3392 Enhance documentation for provenance event type definitions
----
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
[GitHub] nifi pull request #1445: NIFI-3392 Enhance documentation for provenance even...
Posted by alopresto <gi...@git.apache.org>.
Github user alopresto commented on a diff in the pull request:
https://github.com/apache/nifi/pull/1445#discussion_r97922611
--- Diff: nifi-docs/src/main/asciidoc/developer-guide.adoc ---
@@ -848,6 +848,31 @@ Because this documentation is in an HTML format, you may include images and tabl
to best describe this component. The same methods can be used to provide advanced
documentation for Processors, ControllerServices and ReportingTasks.
+[[provenance_events]]
+== Provenance Events
+
+The different event types for provenance reporting are:
+
+[options="header"]
+|======================
+|Provenance Event |Description
--- End diff --
Making line endings consistent (removing all trailing '.').
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
[GitHub] nifi issue #1445: NIFI-3392 Enhance documentation for provenance event type ...
Posted by andrewmlim <gi...@git.apache.org>.
Github user andrewmlim commented on the issue:
https://github.com/apache/nifi/pull/1445
When reviewing, please note that the tables added to the User and Dev Guides, while similar, are actually different. The User Guide has more simple descriptions of the provenance event types, whereas, the Dev Guide has more dev relevant material included from https://github.com/apache/nifi/blob/master/nifi-api/src/main/java/org/apache/nifi/provenance/ProvenanceEventType.java
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
[GitHub] nifi pull request #1445: NIFI-3392 Enhance documentation for provenance even...
Posted by alopresto <gi...@git.apache.org>.
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 '.'.
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
[GitHub] nifi pull request #1445: NIFI-3392 Enhance documentation for provenance even...
Posted by alopresto <gi...@git.apache.org>.
Github user alopresto commented on a diff in the pull request:
https://github.com/apache/nifi/pull/1445#discussion_r97922292
--- Diff: nifi-docs/src/main/asciidoc/administration-guide.adoc ---
@@ -2074,7 +2074,7 @@ The Provenance Repository contains the information related to Data Provenance. T
|====
|*Property*|*Description*
-|nifi.provenance.repository.implementation|The Provenance Repository implementation. The default value is org.apache.nifi.provenance.PersistentProvenanceRepository and should only be changed with caution. To store provenance events in memory instead of on disk (at the risk of data loss in the event of power/machine failure), set this property to org.apache.nifi.provenance.VolatileProvenanceRepository.
+|nifi.provenance.repository.implementation|The Provenance Repository implementation. The default value is org.apache.nifi.provenance.PersistentProvenanceRepository and should only be changed with caution. To store Provenance events in memory instead of on disk (at the risk of data loss in the event of power/machine failure), set this property to org.apache.nifi.provenance.VolatileProvenanceRepository.
--- End diff --
Not sure why the capitalization changed here but I'm reverting; "provenance" is not a proper noun.
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
[GitHub] nifi pull request #1445: NIFI-3392 Enhance documentation for provenance even...
Posted by asfgit <gi...@git.apache.org>.
Github user asfgit closed the pull request at:
https://github.com/apache/nifi/pull/1445
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---