You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@nifi.apache.org by jo...@apache.org on 2020/01/23 03:48:24 UTC
svn commit: r1873052 [30/49] - in /nifi/site/trunk/docs/nifi-docs: ./
components/org.apache.nifi/nifi-ambari-nar/1.11.0/
components/org.apache.nifi/nifi-ambari-nar/1.11.0/org.apache.nifi.reporting.ambari.AmbariReportingTask/
components/org.apache.nifi/...
Added: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-scripting-nar/1.11.0/org.apache.nifi.record.script.ScriptedRecordSetWriter/index.html
URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-scripting-nar/1.11.0/org.apache.nifi.record.script.ScriptedRecordSetWriter/index.html?rev=1873052&view=auto
==============================================================================
--- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-scripting-nar/1.11.0/org.apache.nifi.record.script.ScriptedRecordSetWriter/index.html (added)
+++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-scripting-nar/1.11.0/org.apache.nifi.record.script.ScriptedRecordSetWriter/index.html Thu Jan 23 03:48:17 2020
@@ -0,0 +1 @@
+<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>ScriptedRecordSetWriter</title><link rel="stylesheet" href="../../../../../css/component-usage.css" type="text/css"></link></head><script type="text/javascript">window.onload = function(){if(self==top) { document.getElementById('nameHeader').style.display = "inherit"; } }</script><body><h1 id="nameHeader" style="display: none;">ScriptedRecordSetWriter</h1><h2>Description: </h2><p>Allows the user to provide a scripted RecordSetWriterFactory instance in order to write records to an outgoing flow file.</p><h3>Tags: </h3><p>record, writer, script, invoke, groovy, python, jython, jruby, ruby, javascript, js, lua, luaj</p><h3>Properties: </h3><p>In the list below, the names of required properties appear in <strong>bold</strong>. Any other properties (not in bold) are considered optional. The table also indicates any default values, and whether a property supports the <a href="../../../../../html/expression-language-g
uide.html">NiFi Expression Language</a>.</p><table id="properties"><tr><th>Name</th><th>Default Value</th><th>Allowable Values</th><th>Description</th></tr><tr><td id="name"><strong>Script Engine</strong></td><td id="default-value">Clojure</td><td id="allowable-values"><ul><li>Clojure</li><li>ECMAScript</li><li>Groovy</li><li>lua</li><li>python</li><li>ruby</li></ul></td><td id="description">The engine to execute scripts</td></tr><tr><td id="name">Script File</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Path to script file to execute. Only one of Script File or Script Body may be used<br/><strong>Supports Expression Language: true (will be evaluated using variable registry only)</strong></td></tr><tr><td id="name">Script Body</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Body of script to execute. Only one of Script File or Script Body may be used</td></tr><tr><td id="name">Module Directory</td><td id="defa
ult-value"></td><td id="allowable-values"></td><td id="description">Comma-separated list of paths to files and/or directories which contain modules required by the script.<br/><strong>Supports Expression Language: true (will be evaluated using variable registry only)</strong></td></tr></table><h3>State management: </h3>This component does not store state.<h3>Restricted: </h3><table id="restrictions"><tr><th>Required Permission</th><th>Explanation</th></tr><tr><td>execute code</td><td>Provides operator the ability to execute arbitrary code assuming all permissions that NiFi has.</td></tr></table><h3>System Resource Considerations:</h3>None specified.</body></html>
\ No newline at end of file
Added: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-scripting-nar/1.11.0/org.apache.nifi.record.sink.script.ScriptedRecordSink/index.html
URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-scripting-nar/1.11.0/org.apache.nifi.record.sink.script.ScriptedRecordSink/index.html?rev=1873052&view=auto
==============================================================================
--- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-scripting-nar/1.11.0/org.apache.nifi.record.sink.script.ScriptedRecordSink/index.html (added)
+++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-scripting-nar/1.11.0/org.apache.nifi.record.sink.script.ScriptedRecordSink/index.html Thu Jan 23 03:48:17 2020
@@ -0,0 +1 @@
+<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>ScriptedRecordSink</title><link rel="stylesheet" href="../../../../../css/component-usage.css" type="text/css"></link></head><script type="text/javascript">window.onload = function(){if(self==top) { document.getElementById('nameHeader').style.display = "inherit"; } }</script><body><h1 id="nameHeader" style="display: none;">ScriptedRecordSink</h1><h2>Description: </h2><p>Allows the user to provide a scripted RecordSinkService instance in order to transmit records to the desired target. The script must set a variable 'recordSink' to an implementation of RecordSinkService.</p><h3>Tags: </h3><p>record, record sink, script, invoke, groovy, python, jython, jruby, ruby, javascript, js, lua, luaj</p><h3>Properties: </h3><p>In the list below, the names of required properties appear in <strong>bold</strong>. Any other properties (not in bold) are considered optional. The table also indicates any default values, and wheth
er a property supports the <a href="../../../../../html/expression-language-guide.html">NiFi Expression Language</a>.</p><table id="properties"><tr><th>Name</th><th>Default Value</th><th>Allowable Values</th><th>Description</th></tr><tr><td id="name"><strong>Script Engine</strong></td><td id="default-value">Clojure</td><td id="allowable-values"><ul><li>Clojure</li><li>ECMAScript</li><li>Groovy</li><li>lua</li><li>python</li><li>ruby</li></ul></td><td id="description">The engine to execute scripts</td></tr><tr><td id="name">Script File</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Path to script file to execute. Only one of Script File or Script Body may be used<br/><strong>Supports Expression Language: true (will be evaluated using variable registry only)</strong></td></tr><tr><td id="name">Script Body</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Body of script to execute. Only one of Script File or Script
Body may be used</td></tr><tr><td id="name">Module Directory</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Comma-separated list of paths to files and/or directories which contain modules required by the script.<br/><strong>Supports Expression Language: true (will be evaluated using variable registry only)</strong></td></tr></table><h3>State management: </h3>This component does not store state.<h3>Restricted: </h3><table id="restrictions"><tr><th>Required Permission</th><th>Explanation</th></tr><tr><td>execute code</td><td>Provides operator the ability to execute arbitrary code assuming all permissions that NiFi has.</td></tr></table><h3>System Resource Considerations:</h3>None specified.</body></html>
\ No newline at end of file
Added: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-scripting-nar/1.11.0/org.apache.nifi.reporting.script.ScriptedReportingTask/index.html
URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-scripting-nar/1.11.0/org.apache.nifi.reporting.script.ScriptedReportingTask/index.html?rev=1873052&view=auto
==============================================================================
--- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-scripting-nar/1.11.0/org.apache.nifi.reporting.script.ScriptedReportingTask/index.html (added)
+++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-scripting-nar/1.11.0/org.apache.nifi.reporting.script.ScriptedReportingTask/index.html Thu Jan 23 03:48:17 2020
@@ -0,0 +1 @@
+<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>ScriptedReportingTask</title><link rel="stylesheet" href="../../../../../css/component-usage.css" type="text/css"></link></head><script type="text/javascript">window.onload = function(){if(self==top) { document.getElementById('nameHeader').style.display = "inherit"; } }</script><body><h1 id="nameHeader" style="display: none;">ScriptedReportingTask</h1><h2>Description: </h2><p>Provides reporting and status information to a script. ReportingContext, ComponentLog, and VirtualMachineMetrics objects are made available as variables (context, log, and vmMetrics, respectively) to the script for further processing. The context makes various information available such as events, provenance, bulletins, controller services, process groups, Java Virtual Machine metrics, etc.</p><h3>Tags: </h3><p>reporting, script, execute, groovy, python, jython, jruby, ruby, javascript, js, lua, luaj</p><h3>Properties: </h3><p>In the list
below, the names of required properties appear in <strong>bold</strong>. Any other properties (not in bold) are considered optional. The table also indicates any default values, and whether a property supports the <a href="../../../../../html/expression-language-guide.html">NiFi Expression Language</a>.</p><table id="properties"><tr><th>Name</th><th>Default Value</th><th>Allowable Values</th><th>Description</th></tr><tr><td id="name"><strong>Script Engine</strong></td><td id="default-value">Clojure</td><td id="allowable-values"><ul><li>Clojure</li><li>ECMAScript</li><li>Groovy</li><li>lua</li><li>python</li><li>ruby</li></ul></td><td id="description">The engine to execute scripts</td></tr><tr><td id="name">Script File</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Path to script file to execute. Only one of Script File or Script Body may be used<br/><strong>Supports Expression Language: true (will be evaluated using variable registry only)</stron
g></td></tr><tr><td id="name">Script Body</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Body of script to execute. Only one of Script File or Script Body may be used</td></tr><tr><td id="name">Module Directory</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Comma-separated list of paths to files and/or directories which contain modules required by the script.<br/><strong>Supports Expression Language: true (will be evaluated using variable registry only)</strong></td></tr></table><h3>Dynamic Properties: </h3><p>Dynamic Properties allow the user to specify both the name and value of a property.<table id="dynamic-properties"><tr><th>Name</th><th>Value</th><th>Description</th></tr><tr><td id="name">A script engine property to update</td><td id="value">The value to set it to</td><td>Updates a script engine property specified by the Dynamic Property's key with the value specified by the Dynamic Property's value<br/>
<strong>Supports Expression Language: true (will be evaluated using variable registry only)</strong></td></tr></table></p><h3>State management: </h3>This component does not store state.<h3>Restricted: </h3><table id="restrictions"><tr><th>Required Permission</th><th>Explanation</th></tr><tr><td>execute code</td><td>Provides operator the ability to execute arbitrary code assuming all permissions that NiFi has.</td></tr></table><h3>System Resource Considerations:</h3>None specified.</body></html>
\ No newline at end of file
Added: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-scripting-nar/1.11.0/org.apache.nifi.rules.engine.script.ScriptedRulesEngine/index.html
URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-scripting-nar/1.11.0/org.apache.nifi.rules.engine.script.ScriptedRulesEngine/index.html?rev=1873052&view=auto
==============================================================================
--- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-scripting-nar/1.11.0/org.apache.nifi.rules.engine.script.ScriptedRulesEngine/index.html (added)
+++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-scripting-nar/1.11.0/org.apache.nifi.rules.engine.script.ScriptedRulesEngine/index.html Thu Jan 23 03:48:17 2020
@@ -0,0 +1 @@
+<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>ScriptedRulesEngine</title><link rel="stylesheet" href="../../../../../css/component-usage.css" type="text/css"></link></head><script type="text/javascript">window.onload = function(){if(self==top) { document.getElementById('nameHeader').style.display = "inherit"; } }</script><body><h1 id="nameHeader" style="display: none;">ScriptedRulesEngine</h1><h2>Description: </h2><p>Allows the user to provide a scripted RulesEngineService for custom firing of rules depending on the supplied facts. The script must set a variable 'rulesEngine' to an implementation of RulesEngineService.</p><h3>Tags: </h3><p>rules, rules engine, script, invoke, groovy, python, jython, jruby, ruby, javascript, js, lua, luaj</p><h3>Properties: </h3><p>In the list below, the names of required properties appear in <strong>bold</strong>. Any other properties (not in bold) are considered optional. The table also indicates any default values, and w
hether a property supports the <a href="../../../../../html/expression-language-guide.html">NiFi Expression Language</a>.</p><table id="properties"><tr><th>Name</th><th>Default Value</th><th>Allowable Values</th><th>Description</th></tr><tr><td id="name"><strong>Script Engine</strong></td><td id="default-value">Clojure</td><td id="allowable-values"><ul><li>Clojure</li><li>ECMAScript</li><li>Groovy</li><li>lua</li><li>python</li><li>ruby</li></ul></td><td id="description">The engine to execute scripts</td></tr><tr><td id="name">Script File</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Path to script file to execute. Only one of Script File or Script Body may be used<br/><strong>Supports Expression Language: true (will be evaluated using variable registry only)</strong></td></tr><tr><td id="name">Script Body</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Body of script to execute. Only one of Script File or Scr
ipt Body may be used</td></tr><tr><td id="name">Module Directory</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Comma-separated list of paths to files and/or directories which contain modules required by the script.<br/><strong>Supports Expression Language: true (will be evaluated using variable registry only)</strong></td></tr></table><h3>State management: </h3>This component does not store state.<h3>Restricted: </h3><table id="restrictions"><tr><th>Required Permission</th><th>Explanation</th></tr><tr><td>execute code</td><td>Provides operator the ability to execute arbitrary code assuming all permissions that NiFi has.</td></tr></table><h3>System Resource Considerations:</h3>None specified.</body></html>
\ No newline at end of file
Added: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-scripting-nar/1.11.0/org.apache.nifi.rules.handlers.script.ScriptedActionHandler/index.html
URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-scripting-nar/1.11.0/org.apache.nifi.rules.handlers.script.ScriptedActionHandler/index.html?rev=1873052&view=auto
==============================================================================
--- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-scripting-nar/1.11.0/org.apache.nifi.rules.handlers.script.ScriptedActionHandler/index.html (added)
+++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-scripting-nar/1.11.0/org.apache.nifi.rules.handlers.script.ScriptedActionHandler/index.html Thu Jan 23 03:48:17 2020
@@ -0,0 +1 @@
+<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>ScriptedActionHandler</title><link rel="stylesheet" href="../../../../../css/component-usage.css" type="text/css"></link></head><script type="text/javascript">window.onload = function(){if(self==top) { document.getElementById('nameHeader').style.display = "inherit"; } }</script><body><h1 id="nameHeader" style="display: none;">ScriptedActionHandler</h1><h2>Description: </h2><p>Allows the user to provide a scripted ActionHandler for custom firing of rules depending on the supplied facts. The script must set a variable 'actionHandler' to an implementation of ActionHandler.</p><h3>Tags: </h3><p>rules, rules engine, action, action handler, script, invoke, groovy, python, jython, jruby, ruby, javascript, js, lua, luaj</p><h3>Properties: </h3><p>In the list below, the names of required properties appear in <strong>bold</strong>. Any other properties (not in bold) are considered optional. The table also indicates any d
efault values, and whether a property supports the <a href="../../../../../html/expression-language-guide.html">NiFi Expression Language</a>.</p><table id="properties"><tr><th>Name</th><th>Default Value</th><th>Allowable Values</th><th>Description</th></tr><tr><td id="name"><strong>Script Engine</strong></td><td id="default-value">Clojure</td><td id="allowable-values"><ul><li>Clojure</li><li>ECMAScript</li><li>Groovy</li><li>lua</li><li>python</li><li>ruby</li></ul></td><td id="description">The engine to execute scripts</td></tr><tr><td id="name">Script File</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Path to script file to execute. Only one of Script File or Script Body may be used<br/><strong>Supports Expression Language: true (will be evaluated using variable registry only)</strong></td></tr><tr><td id="name">Script Body</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Body of script to execute. Only one o
f Script File or Script Body may be used</td></tr><tr><td id="name">Module Directory</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Comma-separated list of paths to files and/or directories which contain modules required by the script.<br/><strong>Supports Expression Language: true (will be evaluated using variable registry only)</strong></td></tr></table><h3>State management: </h3>This component does not store state.<h3>Restricted: </h3><table id="restrictions"><tr><th>Required Permission</th><th>Explanation</th></tr><tr><td>execute code</td><td>Provides operator the ability to execute arbitrary code assuming all permissions that NiFi has.</td></tr></table><h3>System Resource Considerations:</h3>None specified.</body></html>
\ No newline at end of file
Added: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-site-to-site-reporting-nar/1.11.0/org.apache.nifi.reporting.SiteToSiteBulletinReportingTask/additionalDetails.html
URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-site-to-site-reporting-nar/1.11.0/org.apache.nifi.reporting.SiteToSiteBulletinReportingTask/additionalDetails.html?rev=1873052&view=auto
==============================================================================
--- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-site-to-site-reporting-nar/1.11.0/org.apache.nifi.reporting.SiteToSiteBulletinReportingTask/additionalDetails.html (added)
+++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-site-to-site-reporting-nar/1.11.0/org.apache.nifi.reporting.SiteToSiteBulletinReportingTask/additionalDetails.html Thu Jan 23 03:48:17 2020
@@ -0,0 +1,65 @@
+<!DOCTYPE html>
+<html lang="en">
+ <!--
+ 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.
+ -->
+ <head>
+ <meta charset="utf-8" />
+ <title>SiteToSiteBulletinReportingTask</title>
+
+ <link rel="stylesheet" href="../../../../../css/component-usage.css" type="text/css" />
+ </head>
+
+ <body>
+ <p>
+ The Site-to-Site Bulletin Reporting Task allows the user to publish Bulletin events using the Site To Site protocol. Note:
+ only up to 5 bulletins are stored per component and up to 10 bulletins at controller level for a duration of up to 5 minutes.
+ If this reporting task is not scheduled frequently enough some bulletins may not be sent.
+ </p>
+
+ <h2>Record writer</h2>
+
+ <p>
+ The user can define a Record Writer and directly specify the output format and data with the assumption that the input schema
+ is the following:
+ </p>
+
+ <pre>
+ <code>
+{
+ "type" : "record",
+ "name" : "bulletins",
+ "namespace" : "bulletins",
+ "fields" : [
+ { "name" : "objectId", "type" : "string" },
+ { "name" : "platform", "type" : "string" },
+ { "name" : "bulletinId", "type" : "long" },
+ { "name" : "bulletinCategory", "type" : ["string", "null"] },
+ { "name" : "bulletinGroupId", "type" : ["string", "null"] },
+ { "name" : "bulletinGroupName", "type" : ["string", "null"] },
+ { "name" : "bulletinLevel", "type" : ["string", "null"] },
+ { "name" : "bulletinMessage", "type" : ["string", "null"] },
+ { "name" : "bulletinNodeAddress", "type" : ["string", "null"] },
+ { "name" : "bulletinNodeId", "type" : ["string", "null"] },
+ { "name" : "bulletinSourceId", "type" : ["string", "null"] },
+ { "name" : "bulletinSourceName", "type" : ["string", "null"] },
+ { "name" : "bulletinSourceType", "type" : ["string", "null"] },
+ { "name" : "bulletinTimestamp", "type" : ["string", "null"], "doc" : "Format: yyyy-MM-dd'T'HH:mm:ss.SSS'Z'" }
+ ]
+}
+ </code>
+ </pre>
+
+ </body>
+</html>
\ No newline at end of file
Added: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-site-to-site-reporting-nar/1.11.0/org.apache.nifi.reporting.SiteToSiteBulletinReportingTask/index.html
URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-site-to-site-reporting-nar/1.11.0/org.apache.nifi.reporting.SiteToSiteBulletinReportingTask/index.html?rev=1873052&view=auto
==============================================================================
--- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-site-to-site-reporting-nar/1.11.0/org.apache.nifi.reporting.SiteToSiteBulletinReportingTask/index.html (added)
+++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-site-to-site-reporting-nar/1.11.0/org.apache.nifi.reporting.SiteToSiteBulletinReportingTask/index.html Thu Jan 23 03:48:17 2020
@@ -0,0 +1 @@
+<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>SiteToSiteBulletinReportingTask</title><link rel="stylesheet" href="../../../../../css/component-usage.css" type="text/css"></link></head><script type="text/javascript">window.onload = function(){if(self==top) { document.getElementById('nameHeader').style.display = "inherit"; } }</script><body><h1 id="nameHeader" style="display: none;">SiteToSiteBulletinReportingTask</h1><h2>Description: </h2><p>Publishes Bulletin events using the Site To Site protocol. Note: only up to 5 bulletins are stored per component and up to 10 bulletins at controller level for a duration of up to 5 minutes. If this reporting task is not scheduled frequently enough some bulletins may not be sent.</p><p><a href="additionalDetails.html">Additional Details...</a></p><h3>Tags: </h3><p>bulletin, site, site to site</p><h3>Properties: </h3><p>In the list below, the names of required properties appear in <strong>bold</strong>. Any other propert
ies (not in bold) are considered optional. The table also indicates any default values, whether a property supports the <a href="../../../../../html/expression-language-guide.html">NiFi Expression Language</a>, and whether a property is considered "sensitive", meaning that its value will be encrypted. Before entering a value in a sensitive property, ensure that the <strong>nifi.properties</strong> file has an entry for the property <strong>nifi.sensitive.props.key</strong>.</p><table id="properties"><tr><th>Name</th><th>Default Value</th><th>Allowable Values</th><th>Description</th></tr><tr><td id="name"><strong>Destination URL</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The URL of the destination NiFi instance or, if clustered, a comma-separated list of address in the format of http(s)://host:port/nifi. This destination URL will only be used to initiate the Site-to-Site connection. The data sent by this reporting task will be load-ba
lanced on all the nodes of the destination (if clustered).<br/><strong>Supports Expression Language: true (will be evaluated using variable registry only)</strong></td></tr><tr><td id="name"><strong>Input Port Name</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The name of the Input Port to deliver data to.<br/><strong>Supports Expression Language: true (will be evaluated using variable registry only)</strong></td></tr><tr><td id="name">SSL Context Service</td><td id="default-value"></td><td id="allowable-values"><strong>Controller Service API: </strong><br/>RestrictedSSLContextService<br/><strong>Implementation: </strong><a href="../../../nifi-ssl-context-service-nar/1.11.0/org.apache.nifi.ssl.StandardRestrictedSSLContextService/index.html">StandardRestrictedSSLContextService</a></td><td id="description">The SSL Context Service to use when communicating with the destination. If not specified, communications will not be secure.</td></tr>
<tr><td id="name"><strong>Instance URL</strong></td><td id="default-value">http://${hostname(true)}:8080/nifi</td><td id="allowable-values"></td><td id="description">The URL of this instance to use in the Content URI of each event.<br/><strong>Supports Expression Language: true (will be evaluated using variable registry only)</strong></td></tr><tr><td id="name"><strong>Compress Events</strong></td><td id="default-value">true</td><td id="allowable-values"><ul><li>true</li><li>false</li></ul></td><td id="description">Indicates whether or not to compress the data being sent.</td></tr><tr><td id="name"><strong>Communications Timeout</strong></td><td id="default-value">30 secs</td><td id="allowable-values"></td><td id="description">Specifies how long to wait to a response from the destination before deciding that an error has occurred and canceling the transaction</td></tr><tr><td id="name"><strong>Transport Protocol</strong></td><td id="default-value">RAW</td><td id="allowable-values"><
ul><li>RAW</li><li>HTTP</li></ul></td><td id="description">Specifies which transport protocol to use for Site-to-Site communication.</td></tr><tr><td id="name">HTTP Proxy hostname</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Specify the proxy server's hostname to use. If not specified, HTTP traffics are sent directly to the target NiFi instance.</td></tr><tr><td id="name">HTTP Proxy port</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Specify the proxy server's port number, optional. If not specified, default port 80 will be used.</td></tr><tr><td id="name">HTTP Proxy username</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Specify an user name to connect to the proxy server, optional.</td></tr><tr><td id="name">HTTP Proxy password</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Specify an user password to connect to the proxy server, opt
ional.<br/><strong>Sensitive Property: true</strong></td></tr><tr><td id="name">Record Writer</td><td id="default-value"></td><td id="allowable-values"><strong>Controller Service API: </strong><br/>RecordSetWriterFactory<br/><strong>Implementations: </strong><a href="../../../nifi-parquet-nar/1.11.0/org.apache.nifi.parquet.ParquetRecordSetWriter/index.html">ParquetRecordSetWriter</a><br/><a href="../../../nifi-scripting-nar/1.11.0/org.apache.nifi.record.script.ScriptedRecordSetWriter/index.html">ScriptedRecordSetWriter</a><br/><a href="../../../nifi-record-serialization-services-nar/1.11.0/org.apache.nifi.text.FreeFormTextRecordSetWriter/index.html">FreeFormTextRecordSetWriter</a><br/><a href="../../../nifi-record-serialization-services-nar/1.11.0/org.apache.nifi.csv.CSVRecordSetWriter/index.html">CSVRecordSetWriter</a><br/><a href="../../../nifi-record-serialization-services-nar/1.11.0/org.apache.nifi.xml.XMLRecordSetWriter/index.html">XMLRecordSetWriter</a><br/><a href="../../../n
ifi-record-serialization-services-nar/1.11.0/org.apache.nifi.json.JsonRecordSetWriter/index.html">JsonRecordSetWriter</a><br/><a href="../../../nifi-record-serialization-services-nar/1.11.0/org.apache.nifi.avro.AvroRecordSetWriter/index.html">AvroRecordSetWriter</a></td><td id="description">Specifies the Controller Service to use for writing out the records.</td></tr><tr><td id="name"><strong>Include Null Values</strong></td><td id="default-value">false</td><td id="allowable-values"><ul><li>true</li><li>false</li></ul></td><td id="description">Indicate if null values should be included in records. Default will be false</td></tr><tr><td id="name"><strong>Platform</strong></td><td id="default-value">nifi</td><td id="allowable-values"></td><td id="description">The value to use for the platform field in each event.<br/><strong>Supports Expression Language: true (will be evaluated using variable registry only)</strong></td></tr></table><h3>State management: </h3>This component does not s
tore state.<h3>Restricted: </h3><table id="restrictions"><tr><th>Required Permission</th><th>Explanation</th></tr><tr><td>export nifi details</td><td>Provides operator the ability to send sensitive details contained in bulletin events to any external system.</td></tr></table><h3>System Resource Considerations:</h3>None specified.</body></html>
\ No newline at end of file
Added: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-site-to-site-reporting-nar/1.11.0/org.apache.nifi.reporting.SiteToSiteMetricsReportingTask/additionalDetails.html
URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-site-to-site-reporting-nar/1.11.0/org.apache.nifi.reporting.SiteToSiteMetricsReportingTask/additionalDetails.html?rev=1873052&view=auto
==============================================================================
--- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-site-to-site-reporting-nar/1.11.0/org.apache.nifi.reporting.SiteToSiteMetricsReportingTask/additionalDetails.html (added)
+++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-site-to-site-reporting-nar/1.11.0/org.apache.nifi.reporting.SiteToSiteMetricsReportingTask/additionalDetails.html Thu Jan 23 03:48:17 2020
@@ -0,0 +1,178 @@
+<!DOCTYPE html>
+<html lang="en">
+ <!--
+ 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.
+ -->
+ <head>
+ <meta charset="utf-8" />
+ <title>SiteToSiteMetricsReportingTask</title>
+
+ <link rel="stylesheet" href="../../../../../css/component-usage.css" type="text/css" />
+ </head>
+
+ <body>
+ <p>
+ The Site-to-Site Metrics Reporting Task allows the user to publish NiFi's metrics (as in the Ambari reporting task) to the
+ same NiFi instance or another NiFi instance. This provides a great deal of power because it allows the user to make use of
+ all of the different Processors that are available in NiFi in order to process or distribute that data.
+ </p>
+
+ <h2>Ambari format</h2>
+
+ <p>
+ There are two available output formats. The first one is the Ambari format as defined in the Ambari Metrics Collector
+ API which is a JSON with dynamic keys. If using this format you might be interested by the below Jolt specification to
+ transform the data.
+ </p>
+
+ <pre>
+ <code>
+ [
+ {
+ "operation": "shift",
+ "spec": {
+ "metrics": {
+ "*": {
+ "metrics": {
+ "*": {
+ "$": "metrics.[#4].metrics.time",
+ "@": "metrics.[#4].metrics.value"
+ }
+ },
+ "*": "metrics.[&1].&"
+ }
+ }
+ }
+ }
+ ]
+ </code>
+ </pre>
+
+ <p>
+ This would transform the below sample:
+ </p>
+
+ <pre>
+ <code>
+ {
+ "metrics": [{
+ "metricname": "jvm.gc.time.G1OldGeneration",
+ "appid": "nifi",
+ "instanceid": "8927f4c0-0160-1000-597a-ea764ccd81a7",
+ "hostname": "localhost",
+ "timestamp": "1520456854361",
+ "starttime": "1520456854361",
+ "metrics": {
+ "1520456854361": "0"
+ }
+ }, {
+ "metricname": "jvm.thread_states.terminated",
+ "appid": "nifi",
+ "instanceid": "8927f4c0-0160-1000-597a-ea764ccd81a7",
+ "hostname": "localhost",
+ "timestamp": "1520456854361",
+ "starttime": "1520456854361",
+ "metrics": {
+ "1520456854361": "0"
+ }
+ }]
+ }
+ </code>
+ </pre>
+
+ <p>
+ into:
+ </p>
+
+ <pre>
+ <code>
+ {
+ "metrics": [{
+ "metricname": "jvm.gc.time.G1OldGeneration",
+ "appid": "nifi",
+ "instanceid": "8927f4c0-0160-1000-597a-ea764ccd81a7",
+ "hostname": "localhost",
+ "timestamp": "1520456854361",
+ "starttime": "1520456854361",
+ "metrics": {
+ "time": "1520456854361",
+ "value": "0"
+ }
+ }, {
+ "metricname": "jvm.thread_states.terminated",
+ "appid": "nifi",
+ "instanceid": "8927f4c0-0160-1000-597a-ea764ccd81a7",
+ "hostname": "localhost",
+ "timestamp": "1520456854361",
+ "starttime": "1520456854361",
+ "metrics": {
+ "time": "1520456854361",
+ "value": "0"
+ }
+ }]
+ }
+ </code>
+ </pre>
+
+ <h2>Record format</h2>
+
+ <p>
+ The second format is leveraging the record framework of NiFi so that the user can define a Record Writer and directly
+ specify the output format and data with the assumption that the input schema is the following:
+ </p>
+
+ <pre>
+ <code>
+ {
+ "type" : "record",
+ "name" : "metrics",
+ "namespace" : "metrics",
+ "fields" : [
+ { "name" : "appid", "type" : "string" },
+ { "name" : "instanceid", "type" : "string" },
+ { "name" : "hostname", "type" : "string" },
+ { "name" : "timestamp", "type" : "long" },
+ { "name" : "loadAverage1min", "type" : "double" },
+ { "name" : "availableCores", "type" : "int" },
+ { "name" : "FlowFilesReceivedLast5Minutes", "type" : "int" },
+ { "name" : "BytesReceivedLast5Minutes", "type" : "long" },
+ { "name" : "FlowFilesSentLast5Minutes", "type" : "int" },
+ { "name" : "BytesSentLast5Minutes", "type" : "long" },
+ { "name" : "FlowFilesQueued", "type" : "int" },
+ { "name" : "BytesQueued", "type" : "long" },
+ { "name" : "BytesReadLast5Minutes", "type" : "long" },
+ { "name" : "BytesWrittenLast5Minutes", "type" : "long" },
+ { "name" : "ActiveThreads", "type" : "int" },
+ { "name" : "TotalTaskDurationSeconds", "type" : "long" },
+ { "name" : "TotalTaskDurationNanoSeconds", "type" : "long" },
+ { "name" : "jvmuptime", "type" : "long" },
+ { "name" : "jvmheap_used", "type" : "double" },
+ { "name" : "jvmheap_usage", "type" : "double" },
+ { "name" : "jvmnon_heap_usage", "type" : "double" },
+ { "name" : "jvmthread_statesrunnable", "type" : ["int", "null"] },
+ { "name" : "jvmthread_statesblocked", "type" : ["int", "null"] },
+ { "name" : "jvmthread_statestimed_waiting", "type" : ["int", "null"] },
+ { "name" : "jvmthread_statesterminated", "type" : ["int", "null"] },
+ { "name" : "jvmthread_count", "type" : "int" },
+ { "name" : "jvmdaemon_thread_count", "type" : "int" },
+ { "name" : "jvmfile_descriptor_usage", "type" : "double" },
+ { "name" : "jvmgcruns", "type" : ["long", "null"] },
+ { "name" : "jvmgctime", "type" : ["long", "null"] }
+ ]
+ }
+ </code>
+ </pre>
+
+ </body>
+</html>
\ No newline at end of file
Added: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-site-to-site-reporting-nar/1.11.0/org.apache.nifi.reporting.SiteToSiteMetricsReportingTask/index.html
URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-site-to-site-reporting-nar/1.11.0/org.apache.nifi.reporting.SiteToSiteMetricsReportingTask/index.html?rev=1873052&view=auto
==============================================================================
--- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-site-to-site-reporting-nar/1.11.0/org.apache.nifi.reporting.SiteToSiteMetricsReportingTask/index.html (added)
+++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-site-to-site-reporting-nar/1.11.0/org.apache.nifi.reporting.SiteToSiteMetricsReportingTask/index.html Thu Jan 23 03:48:17 2020
@@ -0,0 +1 @@
+<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>SiteToSiteMetricsReportingTask</title><link rel="stylesheet" href="../../../../../css/component-usage.css" type="text/css"></link></head><script type="text/javascript">window.onload = function(){if(self==top) { document.getElementById('nameHeader').style.display = "inherit"; } }</script><body><h1 id="nameHeader" style="display: none;">SiteToSiteMetricsReportingTask</h1><h2>Description: </h2><p>Publishes same metrics as the Ambari Reporting task using the Site To Site protocol.</p><p><a href="additionalDetails.html">Additional Details...</a></p><h3>Tags: </h3><p>status, metrics, site, site to site</p><h3>Properties: </h3><p>In the list below, the names of required properties appear in <strong>bold</strong>. Any other properties (not in bold) are considered optional. The table also indicates any default values, whether a property supports the <a href="../../../../../html/expression-language-guide.html">NiFi Expre
ssion Language</a>, and whether a property is considered "sensitive", meaning that its value will be encrypted. Before entering a value in a sensitive property, ensure that the <strong>nifi.properties</strong> file has an entry for the property <strong>nifi.sensitive.props.key</strong>.</p><table id="properties"><tr><th>Name</th><th>Default Value</th><th>Allowable Values</th><th>Description</th></tr><tr><td id="name"><strong>Destination URL</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The URL of the destination NiFi instance or, if clustered, a comma-separated list of address in the format of http(s)://host:port/nifi. This destination URL will only be used to initiate the Site-to-Site connection. The data sent by this reporting task will be load-balanced on all the nodes of the destination (if clustered).<br/><strong>Supports Expression Language: true (will be evaluated using variable registry only)</strong></td></tr><tr><td id="name">
<strong>Input Port Name</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The name of the Input Port to deliver data to.<br/><strong>Supports Expression Language: true (will be evaluated using variable registry only)</strong></td></tr><tr><td id="name">SSL Context Service</td><td id="default-value"></td><td id="allowable-values"><strong>Controller Service API: </strong><br/>RestrictedSSLContextService<br/><strong>Implementation: </strong><a href="../../../nifi-ssl-context-service-nar/1.11.0/org.apache.nifi.ssl.StandardRestrictedSSLContextService/index.html">StandardRestrictedSSLContextService</a></td><td id="description">The SSL Context Service to use when communicating with the destination. If not specified, communications will not be secure.</td></tr><tr><td id="name"><strong>Instance URL</strong></td><td id="default-value">http://${hostname(true)}:8080/nifi</td><td id="allowable-values"></td><td id="description">The URL of this instance
to use in the Content URI of each event.<br/><strong>Supports Expression Language: true (will be evaluated using variable registry only)</strong></td></tr><tr><td id="name"><strong>Compress Events</strong></td><td id="default-value">true</td><td id="allowable-values"><ul><li>true</li><li>false</li></ul></td><td id="description">Indicates whether or not to compress the data being sent.</td></tr><tr><td id="name"><strong>Communications Timeout</strong></td><td id="default-value">30 secs</td><td id="allowable-values"></td><td id="description">Specifies how long to wait to a response from the destination before deciding that an error has occurred and canceling the transaction</td></tr><tr><td id="name"><strong>Transport Protocol</strong></td><td id="default-value">RAW</td><td id="allowable-values"><ul><li>RAW</li><li>HTTP</li></ul></td><td id="description">Specifies which transport protocol to use for Site-to-Site communication.</td></tr><tr><td id="name">HTTP Proxy hostname</td><td id=
"default-value"></td><td id="allowable-values"></td><td id="description">Specify the proxy server's hostname to use. If not specified, HTTP traffics are sent directly to the target NiFi instance.</td></tr><tr><td id="name">HTTP Proxy port</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Specify the proxy server's port number, optional. If not specified, default port 80 will be used.</td></tr><tr><td id="name">HTTP Proxy username</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Specify an user name to connect to the proxy server, optional.</td></tr><tr><td id="name">HTTP Proxy password</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Specify an user password to connect to the proxy server, optional.<br/><strong>Sensitive Property: true</strong></td></tr><tr><td id="name">Record Writer</td><td id="default-value"></td><td id="allowable-values"><strong>Controller Service API: </stron
g><br/>RecordSetWriterFactory<br/><strong>Implementations: </strong><a href="../../../nifi-parquet-nar/1.11.0/org.apache.nifi.parquet.ParquetRecordSetWriter/index.html">ParquetRecordSetWriter</a><br/><a href="../../../nifi-scripting-nar/1.11.0/org.apache.nifi.record.script.ScriptedRecordSetWriter/index.html">ScriptedRecordSetWriter</a><br/><a href="../../../nifi-record-serialization-services-nar/1.11.0/org.apache.nifi.text.FreeFormTextRecordSetWriter/index.html">FreeFormTextRecordSetWriter</a><br/><a href="../../../nifi-record-serialization-services-nar/1.11.0/org.apache.nifi.csv.CSVRecordSetWriter/index.html">CSVRecordSetWriter</a><br/><a href="../../../nifi-record-serialization-services-nar/1.11.0/org.apache.nifi.xml.XMLRecordSetWriter/index.html">XMLRecordSetWriter</a><br/><a href="../../../nifi-record-serialization-services-nar/1.11.0/org.apache.nifi.json.JsonRecordSetWriter/index.html">JsonRecordSetWriter</a><br/><a href="../../../nifi-record-serialization-services-nar/1.11.0/o
rg.apache.nifi.avro.AvroRecordSetWriter/index.html">AvroRecordSetWriter</a></td><td id="description">Specifies the Controller Service to use for writing out the records.</td></tr><tr><td id="name"><strong>Include Null Values</strong></td><td id="default-value">false</td><td id="allowable-values"><ul><li>true</li><li>false</li></ul></td><td id="description">Indicate if null values should be included in records. Default will be false</td></tr><tr><td id="name"><strong>Hostname</strong></td><td id="default-value">${hostname(true)}</td><td id="allowable-values"></td><td id="description">The Hostname of this NiFi instance to be included in the metrics<br/><strong>Supports Expression Language: true (will be evaluated using variable registry only)</strong></td></tr><tr><td id="name"><strong>Application ID</strong></td><td id="default-value">nifi</td><td id="allowable-values"></td><td id="description">The Application ID to be included in the metrics<br/><strong>Supports Expression Language:
true (will be evaluated using variable registry only)</strong></td></tr><tr><td id="name"><strong>Output Format</strong></td><td id="default-value">ambari-format</td><td id="allowable-values"><ul><li>Ambari Format <img src="../../../../../html/images/iconInfo.png" alt="Metrics will be formatted according to the Ambari Metrics API. See Additional Details in Usage documentation." title="Metrics will be formatted according to the Ambari Metrics API. See Additional Details in Usage documentation."></img></li><li>Record Format <img src="../../../../../html/images/iconInfo.png" alt="Metrics will be formatted using the Record Writer property of this reporting task. See Additional Details in Usage documentation to have the description of the default schema." title="Metrics will be formatted using the Record Writer property of this reporting task. See Additional Details in Usage documentation to have the description of the default schema."></img></li></ul></td><td id="description">The outpu
t format that will be used for the metrics. If Record Format is selected, a Record Writer must be provided. If Ambari Format is selected, the Record Writer property should be empty.</td></tr></table><h3>State management: </h3>This component does not store state.<h3>Restricted: </h3>This component is not restricted.<h3>System Resource Considerations:</h3>None specified.</body></html>
\ No newline at end of file
Added: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-site-to-site-reporting-nar/1.11.0/org.apache.nifi.reporting.SiteToSiteProvenanceReportingTask/additionalDetails.html
URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-site-to-site-reporting-nar/1.11.0/org.apache.nifi.reporting.SiteToSiteProvenanceReportingTask/additionalDetails.html?rev=1873052&view=auto
==============================================================================
--- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-site-to-site-reporting-nar/1.11.0/org.apache.nifi.reporting.SiteToSiteProvenanceReportingTask/additionalDetails.html (added)
+++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-site-to-site-reporting-nar/1.11.0/org.apache.nifi.reporting.SiteToSiteProvenanceReportingTask/additionalDetails.html Thu Jan 23 03:48:17 2020
@@ -0,0 +1,82 @@
+<!DOCTYPE html>
+<html lang="en">
+ <!--
+ 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.
+ -->
+ <head>
+ <meta charset="utf-8" />
+ <title>SiteToSiteProvenanceReportingTask</title>
+
+ <link rel="stylesheet" href="../../../../../css/component-usage.css" type="text/css" />
+ </head>
+
+ <body>
+ <p>
+ The Site-to-Site Provenance Reporting Task allows the user to publish all of the Provenance Events from a NiFi instance back to
+ the same NiFi instance or another NiFi instance. This provides a great deal of power because it allows the user to make use of
+ all of the different Processors that are available in NiFi in order to process or distribute that data. When possible, it is
+ advisable to send the Provenance data to a different NiFi instance than the one that this Reporting Task is running on, because
+ when the data is received over Site-to-Site and processed, that in and of itself will generate Provenance events. As a result, there
+ is a cycle that is created. However, the data is sent in batches (1,000 by default). This means that for each batch of Provenance events
+ that are sent back to NiFi, the receiving NiFi will have to generate only a single event per component.
+ </p>
+
+ <p>
+ By default, when published to a NiFi instance, the Provenance data is sent as a JSON array. However, the user can define a Record Writer
+ and directly specify the output format and data with the assumption that the input schema is defined as follows:
+ </p>
+
+<pre>
+<code>
+{
+ "type" : "record",
+ "name" : "provenance",
+ "namespace" : "provenance",
+ "fields": [
+ { "name": "eventId", "type": "string" },
+ { "name": "eventOrdinal", "type": "long" },
+ { "name": "eventType", "type": "string" },
+ { "name": "timestampMillis", "type": "long" },
+ { "name": "durationMillis", "type": "long" },
+ { "name": "lineageStart", "type": { "type": "long", "logicalType": "timestamp-millis" } },
+ { "name": "details", "type": ["null", "string"] },
+ { "name": "componentId", "type": ["null", "string"] },
+ { "name": "componentType", "type": ["null", "string"] },
+ { "name": "componentName", "type": ["null", "string"] },
+ { "name": "processGroupId", "type": ["null", "string"] },
+ { "name": "processGroupName", "type": ["null", "string"] },
+ { "name": "entityId", "type": ["null", "string"] },
+ { "name": "entityType", "type": ["null", "string"] },
+ { "name": "entitySize", "type": ["null", "long"] },
+ { "name": "previousEntitySize", "type": ["null", "long"] },
+ { "name": "updatedAttributes", "type": { "type": "map", "values": "string" } },
+ { "name": "previousAttributes", "type": { "type": "map", "values": "string" } },
+ { "name": "actorHostname", "type": ["null", "string"] },
+ { "name": "contentURI", "type": ["null", "string"] },
+ { "name": "previousContentURI", "type": ["null", "string"] },
+ { "name": "parentIds", "type": { "type": "array", "items": "string" } },
+ { "name": "childIds", "type": { "type": "array", "items": "string" } },
+ { "name": "platform", "type": "string" },
+ { "name": "application", "type": "string" },
+ { "name": "remoteIdentifier", "type": ["null", "string"] },
+ { "name": "alternateIdentifier", "type": ["null", "string"] },
+ { "name": "transitUri", "type": ["null", "string"] }
+ ]
+}
+</code>
+</pre>
+
+
+ </body>
+</html>
\ No newline at end of file
Added: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-site-to-site-reporting-nar/1.11.0/org.apache.nifi.reporting.SiteToSiteProvenanceReportingTask/index.html
URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-site-to-site-reporting-nar/1.11.0/org.apache.nifi.reporting.SiteToSiteProvenanceReportingTask/index.html?rev=1873052&view=auto
==============================================================================
--- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-site-to-site-reporting-nar/1.11.0/org.apache.nifi.reporting.SiteToSiteProvenanceReportingTask/index.html (added)
+++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-site-to-site-reporting-nar/1.11.0/org.apache.nifi.reporting.SiteToSiteProvenanceReportingTask/index.html Thu Jan 23 03:48:17 2020
@@ -0,0 +1 @@
+<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>SiteToSiteProvenanceReportingTask</title><link rel="stylesheet" href="../../../../../css/component-usage.css" type="text/css"></link></head><script type="text/javascript">window.onload = function(){if(self==top) { document.getElementById('nameHeader').style.display = "inherit"; } }</script><body><h1 id="nameHeader" style="display: none;">SiteToSiteProvenanceReportingTask</h1><h2>Description: </h2><p>Publishes Provenance events using the Site To Site protocol.</p><p><a href="additionalDetails.html">Additional Details...</a></p><h3>Tags: </h3><p>provenance, lineage, tracking, site, site to site</p><h3>Properties: </h3><p>In the list below, the names of required properties appear in <strong>bold</strong>. Any other properties (not in bold) are considered optional. The table also indicates any default values, whether a property supports the <a href="../../../../../html/expression-language-guide.html">NiFi Expressio
n Language</a>, and whether a property is considered "sensitive", meaning that its value will be encrypted. Before entering a value in a sensitive property, ensure that the <strong>nifi.properties</strong> file has an entry for the property <strong>nifi.sensitive.props.key</strong>.</p><table id="properties"><tr><th>Name</th><th>Default Value</th><th>Allowable Values</th><th>Description</th></tr><tr><td id="name"><strong>Destination URL</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The URL of the destination NiFi instance or, if clustered, a comma-separated list of address in the format of http(s)://host:port/nifi. This destination URL will only be used to initiate the Site-to-Site connection. The data sent by this reporting task will be load-balanced on all the nodes of the destination (if clustered).<br/><strong>Supports Expression Language: true (will be evaluated using variable registry only)</strong></td></tr><tr><td id="name"><str
ong>Input Port Name</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The name of the Input Port to deliver data to.<br/><strong>Supports Expression Language: true (will be evaluated using variable registry only)</strong></td></tr><tr><td id="name">SSL Context Service</td><td id="default-value"></td><td id="allowable-values"><strong>Controller Service API: </strong><br/>RestrictedSSLContextService<br/><strong>Implementation: </strong><a href="../../../nifi-ssl-context-service-nar/1.11.0/org.apache.nifi.ssl.StandardRestrictedSSLContextService/index.html">StandardRestrictedSSLContextService</a></td><td id="description">The SSL Context Service to use when communicating with the destination. If not specified, communications will not be secure.</td></tr><tr><td id="name"><strong>Instance URL</strong></td><td id="default-value">http://${hostname(true)}:8080/nifi</td><td id="allowable-values"></td><td id="description">The URL of this instance to u
se in the Content URI of each event.<br/><strong>Supports Expression Language: true (will be evaluated using variable registry only)</strong></td></tr><tr><td id="name"><strong>Compress Events</strong></td><td id="default-value">true</td><td id="allowable-values"><ul><li>true</li><li>false</li></ul></td><td id="description">Indicates whether or not to compress the data being sent.</td></tr><tr><td id="name"><strong>Communications Timeout</strong></td><td id="default-value">30 secs</td><td id="allowable-values"></td><td id="description">Specifies how long to wait to a response from the destination before deciding that an error has occurred and canceling the transaction</td></tr><tr><td id="name"><strong>Batch Size</strong></td><td id="default-value">1000</td><td id="allowable-values"></td><td id="description">Specifies how many records to send in a single batch, at most.</td></tr><tr><td id="name"><strong>Transport Protocol</strong></td><td id="default-value">RAW</td><td id="allowabl
e-values"><ul><li>RAW</li><li>HTTP</li></ul></td><td id="description">Specifies which transport protocol to use for Site-to-Site communication.</td></tr><tr><td id="name">HTTP Proxy hostname</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Specify the proxy server's hostname to use. If not specified, HTTP traffics are sent directly to the target NiFi instance.</td></tr><tr><td id="name">HTTP Proxy port</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Specify the proxy server's port number, optional. If not specified, default port 80 will be used.</td></tr><tr><td id="name">HTTP Proxy username</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Specify an user name to connect to the proxy server, optional.</td></tr><tr><td id="name">HTTP Proxy password</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Specify an user password to connect to the proxy
server, optional.<br/><strong>Sensitive Property: true</strong></td></tr><tr><td id="name">Record Writer</td><td id="default-value"></td><td id="allowable-values"><strong>Controller Service API: </strong><br/>RecordSetWriterFactory<br/><strong>Implementations: </strong><a href="../../../nifi-parquet-nar/1.11.0/org.apache.nifi.parquet.ParquetRecordSetWriter/index.html">ParquetRecordSetWriter</a><br/><a href="../../../nifi-scripting-nar/1.11.0/org.apache.nifi.record.script.ScriptedRecordSetWriter/index.html">ScriptedRecordSetWriter</a><br/><a href="../../../nifi-record-serialization-services-nar/1.11.0/org.apache.nifi.text.FreeFormTextRecordSetWriter/index.html">FreeFormTextRecordSetWriter</a><br/><a href="../../../nifi-record-serialization-services-nar/1.11.0/org.apache.nifi.csv.CSVRecordSetWriter/index.html">CSVRecordSetWriter</a><br/><a href="../../../nifi-record-serialization-services-nar/1.11.0/org.apache.nifi.xml.XMLRecordSetWriter/index.html">XMLRecordSetWriter</a><br/><a href=
"../../../nifi-record-serialization-services-nar/1.11.0/org.apache.nifi.json.JsonRecordSetWriter/index.html">JsonRecordSetWriter</a><br/><a href="../../../nifi-record-serialization-services-nar/1.11.0/org.apache.nifi.avro.AvroRecordSetWriter/index.html">AvroRecordSetWriter</a></td><td id="description">Specifies the Controller Service to use for writing out the records.</td></tr><tr><td id="name"><strong>Include Null Values</strong></td><td id="default-value">false</td><td id="allowable-values"><ul><li>true</li><li>false</li></ul></td><td id="description">Indicate if null values should be included in records. Default will be false</td></tr><tr><td id="name"><strong>Platform</strong></td><td id="default-value">nifi</td><td id="allowable-values"></td><td id="description">The value to use for the platform field in each event.<br/><strong>Supports Expression Language: true (will be evaluated using variable registry only)</strong></td></tr><tr><td id="name">Event Type to Include</td><td i
d="default-value"></td><td id="allowable-values"></td><td id="description">Comma-separated list of event types that will be used to filter the provenance events sent by the reporting task. Available event types are [CREATE, RECEIVE, FETCH, SEND, REMOTE_INVOCATION, DOWNLOAD, DROP, EXPIRE, FORK, JOIN, CLONE, CONTENT_MODIFIED, ATTRIBUTES_MODIFIED, ROUTE, ADDINFO, REPLAY, UNKNOWN]. If no filter is set, all the events are sent. If multiple filters are set, the filters are cumulative.<br/><strong>Supports Expression Language: true (will be evaluated using variable registry only)</strong></td></tr><tr><td id="name">Event Type to Exclude</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Comma-separated list of event types that will be used to exclude the provenance events sent by the reporting task. Available event types are [CREATE, RECEIVE, FETCH, SEND, REMOTE_INVOCATION, DOWNLOAD, DROP, EXPIRE, FORK, JOIN, CLONE, CONTENT_MODIFIED, ATTRIBUTES_MODIFIED, RO
UTE, ADDINFO, REPLAY, UNKNOWN]. If no filter is set, all the events are sent. If multiple filters are set, the filters are cumulative. If an event type is included in Event Type to Include and excluded here, then the exclusion takes precedence and the event will not be sent.<br/><strong>Supports Expression Language: true (will be evaluated using variable registry only)</strong></td></tr><tr><td id="name">Component Type to Include</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Regular expression to filter the provenance events based on the component type. Only the events matching the regular expression will be sent. If no filter is set, all the events are sent. If multiple filters are set, the filters are cumulative.<br/><strong>Supports Expression Language: true (will be evaluated using variable registry only)</strong></td></tr><tr><td id="name">Component Type to Exclude</td><td id="default-value"></td><td id="allowable-values"></td><td id="descr
iption">Regular expression to exclude the provenance events based on the component type. The events matching the regular expression will not be sent. If no filter is set, all the events are sent. If multiple filters are set, the filters are cumulative. If a component type is included in Component Type to Include and excluded here, then the exclusion takes precedence and the event will not be sent.<br/><strong>Supports Expression Language: true (will be evaluated using variable registry only)</strong></td></tr><tr><td id="name">Component ID to Include</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Comma-separated list of component UUID that will be used to filter the provenance events sent by the reporting task. If no filter is set, all the events are sent. If multiple filters are set, the filters are cumulative.<br/><strong>Supports Expression Language: true (will be evaluated using variable registry only)</strong></td></tr><tr><td id="name">Comp
onent ID to Exclude</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Comma-separated list of component UUID that will be used to exclude the provenance events sent by the reporting task. If no filter is set, all the events are sent. If multiple filters are set, the filters are cumulative. If a component UUID is included in Component ID to Include and excluded here, then the exclusion takes precedence and the event will not be sent.<br/><strong>Supports Expression Language: true (will be evaluated using variable registry only)</strong></td></tr><tr><td id="name">Component Name to Include</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Regular expression to filter the provenance events based on the component name. Only the events matching the regular expression will be sent. If no filter is set, all the events are sent. If multiple filters are set, the filters are cumulative.<br/><strong>Supports Expression Languag
e: true (will be evaluated using variable registry only)</strong></td></tr><tr><td id="name">Component Name to Exclude</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Regular expression to exclude the provenance events based on the component name. The events matching the regular expression will not be sent. If no filter is set, all the events are sent. If multiple filters are set, the filters are cumulative. If a component name is included in Component Name to Include and excluded here, then the exclusion takes precedence and the event will not be sent.<br/><strong>Supports Expression Language: true (will be evaluated using variable registry only)</strong></td></tr><tr><td id="name"><strong>Start Position</strong></td><td id="default-value">beginning-of-stream</td><td id="allowable-values"><ul><li>Beginning of Stream <img src="../../../../../html/images/iconInfo.png" alt="Start reading provenance Events from the beginning of the stream (the oldest
event first)" title="Start reading provenance Events from the beginning of the stream (the oldest event first)"></img></li><li>End of Stream <img src="../../../../../html/images/iconInfo.png" alt="Start reading provenance Events from the end of the stream, ignoring old events" title="Start reading provenance Events from the end of the stream, ignoring old events"></img></li></ul></td><td id="description">If the Reporting Task has never been run, or if its state has been reset by a user, specifies where in the stream of Provenance Events the Reporting Task should start</td></tr></table><h3>State management: </h3><table id="stateful"><tr><th>Scope</th><th>Description</th></tr><tr><td>LOCAL</td><td>Stores the Reporting Task's last event Id so that on restart the task knows where it left off.</td></tr></table><h3>Restricted: </h3><table id="restrictions"><tr><th>Required Permission</th><th>Explanation</th></tr><tr><td>export nifi details</td><td>Provides operator the ability to send se
nsitive details contained in Provenance events to any external system.</td></tr></table><h3>System Resource Considerations:</h3>None specified.</body></html>
\ No newline at end of file
Added: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-site-to-site-reporting-nar/1.11.0/org.apache.nifi.reporting.SiteToSiteStatusReportingTask/additionalDetails.html
URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-site-to-site-reporting-nar/1.11.0/org.apache.nifi.reporting.SiteToSiteStatusReportingTask/additionalDetails.html?rev=1873052&view=auto
==============================================================================
--- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-site-to-site-reporting-nar/1.11.0/org.apache.nifi.reporting.SiteToSiteStatusReportingTask/additionalDetails.html (added)
+++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-site-to-site-reporting-nar/1.11.0/org.apache.nifi.reporting.SiteToSiteStatusReportingTask/additionalDetails.html Thu Jan 23 03:48:17 2020
@@ -0,0 +1,133 @@
+<!DOCTYPE html>
+<html lang="en">
+ <!--
+ 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.
+ -->
+ <head>
+ <meta charset="utf-8" />
+ <title>SiteToSiteStatusReportingTask</title>
+
+ <link rel="stylesheet" href="../../../../../css/component-usage.css" type="text/css" />
+ </head>
+
+ <body>
+ <p>
+ The Site-to-Site Status Reporting Task allows the user to publish Status events using the Site To Site protocol.
+ The component type and name filter regexes form a union: only components matching both regexes will be reported.
+ However, all process groups are recursively searched for matching components, regardless of whether the process
+ group matches the component filters.
+ </p>
+
+ <h2>Record writer</h2>
+
+ <p>
+ The user can define a Record Writer and directly specify the output format and data with the assumption that the
+ input schema is the following:
+ </p>
+
+ <pre>
+ <code>
+{
+ "type" : "record",
+ "name" : "status",
+ "namespace" : "status",
+ "fields" : [
+ // common fields for all components
+ { "name" : "statusId", "type" : "string"},
+ { "name" : "timestampMillis", "type": { "type": "long", "logicalType": "timestamp-millis" } },
+ { "name" : "timestamp", "type" : "string"},
+ { "name" : "actorHostname", "type" : "string"},
+ { "name" : "componentType", "type" : "string"},
+ { "name" : "componentName", "type" : "string"},
+ { "name" : "parentId", "type" : ["string", "null"]},
+ { "name" : "platform", "type" : "string"},
+ { "name" : "application", "type" : "string"},
+ { "name" : "componentId", "type" : "string"},
+
+ // PG + RPG + Ports + Processors
+ { "name" : "activeThreadCount", "type" : ["long", "null"]},
+
+ // PG + Ports + Processors
+ { "name" : "flowFilesReceived", "type" : ["long", "null"]},
+ { "name" : "flowFilesSent", "type" : ["long", "null"]},
+
+ // PG + Ports + Processors
+ { "name" : "bytesReceived", "type" : ["long", "null"]},
+ { "name" : "bytesSent", "type" : ["long", "null"]},
+
+ // PG + Connections
+ { "name" : "queuedCount", "type" : ["long", "null"]},
+
+ // PG + Processors
+ { "name" : "bytesRead", "type" : ["long", "null"]},
+ { "name" : "bytesWritten", "type" : ["long", "null"]},
+ { "name" : "terminatedThreadCount", "type" : ["long", "null"]},
+
+ // Processors + Ports
+ { "name" : "runStatus", "type" : ["string", "null"]},
+
+ // fields for process group status
+ { "name" : "bytesTransferred", "type" : ["long", "null"]},
+ { "name" : "flowFilesTransferred", "type" : ["long", "null"]},
+ { "name" : "inputContentSize", "type" : ["long", "null"]},
+ { "name" : "outputContentSize", "type" : ["long", "null"]},
+ { "name" : "queuedContentSize", "type" : ["long", "null"]},
+ { "name" : "versionedFlowStatus", "type" : ["string", "null"]},
+
+ // fields for remote process groups
+ { "name" : "activeRemotePortCount", "type" : ["long", "null"]},
+ { "name" : "inactiveRemotePortCount", "type" : ["long", "null"]},
+ { "name" : "receivedContentSize", "type" : ["long", "null"]},
+ { "name" : "receivedCount", "type" : ["long", "null"]},
+ { "name" : "sentContentSize", "type" : ["long", "null"]},
+ { "name" : "sentCount", "type" : ["long", "null"]},
+ { "name" : "averageLineageDuration", "type" : ["long", "null"]},
+ { "name" : "transmissionStatus", "type" : ["string", "null"]},
+ { "name" : "targetURI", "type" : ["string", "null"]},
+
+ // fields for input/output ports + connections + PG
+ { "name" : "inputBytes", "type" : ["long", "null"]},
+ { "name" : "inputCount", "type" : ["long", "null"]},
+ { "name" : "outputBytes", "type" : ["long", "null"]},
+ { "name" : "outputCount", "type" : ["long", "null"]},
+ { "name" : "transmitting", "type" : ["boolean", "null"]},
+
+ // fields for connections
+ { "name" : "sourceId", "type" : ["string", "null"]},
+ { "name" : "sourceName", "type" : ["string", "null"]},
+ { "name" : "destinationId", "type" : ["string", "null"]},
+ { "name" : "destinationName", "type" : ["string", "null"]},
+ { "name" : "maxQueuedBytes", "type" : ["long", "null"]},
+ { "name" : "maxQueuedCount", "type" : ["long", "null"]},
+ { "name" : "queuedBytes", "type" : ["long", "null"]},
+ { "name" : "backPressureBytesThreshold", "type" : ["long", "null"]},
+ { "name" : "backPressureObjectThreshold", "type" : ["long", "null"]},
+ { "name" : "backPressureDataSizeThreshold", "type" : ["string", "null"]},
+ { "name" : "isBackPressureEnabled", "type" : ["string", "null"]},
+
+ // fields for processors
+ { "name" : "processorType", "type" : ["string", "null"]},
+ { "name" : "averageLineageDurationMS", "type" : ["long", "null"]},
+ { "name" : "flowFilesRemoved", "type" : ["long", "null"]},
+ { "name" : "invocations", "type" : ["long", "null"]},
+ { "name" : "processingNanos", "type" : ["long", "null"]},
+ { "name" : "executionNode", "type" : ["string", "null"]},
+ { "name" : "counters", "type": { "type": "map", "values": "string" }}
+ ]
+}
+ </code>
+ </pre>
+
+ </body>
+</html>
\ No newline at end of file
Added: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-site-to-site-reporting-nar/1.11.0/org.apache.nifi.reporting.SiteToSiteStatusReportingTask/index.html
URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-site-to-site-reporting-nar/1.11.0/org.apache.nifi.reporting.SiteToSiteStatusReportingTask/index.html?rev=1873052&view=auto
==============================================================================
--- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-site-to-site-reporting-nar/1.11.0/org.apache.nifi.reporting.SiteToSiteStatusReportingTask/index.html (added)
+++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-site-to-site-reporting-nar/1.11.0/org.apache.nifi.reporting.SiteToSiteStatusReportingTask/index.html Thu Jan 23 03:48:17 2020
@@ -0,0 +1 @@
+<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>SiteToSiteStatusReportingTask</title><link rel="stylesheet" href="../../../../../css/component-usage.css" type="text/css"></link></head><script type="text/javascript">window.onload = function(){if(self==top) { document.getElementById('nameHeader').style.display = "inherit"; } }</script><body><h1 id="nameHeader" style="display: none;">SiteToSiteStatusReportingTask</h1><h2>Description: </h2><p>Publishes Status events using the Site To Site protocol. The component type and name filter regexes form a union: only components matching both regexes will be reported. However, all process groups are recursively searched for matching components, regardless of whether the process group matches the component filters.</p><p><a href="additionalDetails.html">Additional Details...</a></p><h3>Tags: </h3><p>status, metrics, history, site, site to site</p><h3>Properties: </h3><p>In the list below, the names of required propertie
s appear in <strong>bold</strong>. Any other properties (not in bold) are considered optional. The table also indicates any default values, whether a property supports the <a href="../../../../../html/expression-language-guide.html">NiFi Expression Language</a>, and whether a property is considered "sensitive", meaning that its value will be encrypted. Before entering a value in a sensitive property, ensure that the <strong>nifi.properties</strong> file has an entry for the property <strong>nifi.sensitive.props.key</strong>.</p><table id="properties"><tr><th>Name</th><th>Default Value</th><th>Allowable Values</th><th>Description</th></tr><tr><td id="name"><strong>Destination URL</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The URL of the destination NiFi instance or, if clustered, a comma-separated list of address in the format of http(s)://host:port/nifi. This destination URL will only be used to initiate the Site-to-Site connection.
The data sent by this reporting task will be load-balanced on all the nodes of the destination (if clustered).<br/><strong>Supports Expression Language: true (will be evaluated using variable registry only)</strong></td></tr><tr><td id="name"><strong>Input Port Name</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The name of the Input Port to deliver data to.<br/><strong>Supports Expression Language: true (will be evaluated using variable registry only)</strong></td></tr><tr><td id="name">SSL Context Service</td><td id="default-value"></td><td id="allowable-values"><strong>Controller Service API: </strong><br/>RestrictedSSLContextService<br/><strong>Implementation: </strong><a href="../../../nifi-ssl-context-service-nar/1.11.0/org.apache.nifi.ssl.StandardRestrictedSSLContextService/index.html">StandardRestrictedSSLContextService</a></td><td id="description">The SSL Context Service to use when communicating with the destination. If not spe
cified, communications will not be secure.</td></tr><tr><td id="name"><strong>Instance URL</strong></td><td id="default-value">http://${hostname(true)}:8080/nifi</td><td id="allowable-values"></td><td id="description">The URL of this instance to use in the Content URI of each event.<br/><strong>Supports Expression Language: true (will be evaluated using variable registry only)</strong></td></tr><tr><td id="name"><strong>Compress Events</strong></td><td id="default-value">true</td><td id="allowable-values"><ul><li>true</li><li>false</li></ul></td><td id="description">Indicates whether or not to compress the data being sent.</td></tr><tr><td id="name"><strong>Communications Timeout</strong></td><td id="default-value">30 secs</td><td id="allowable-values"></td><td id="description">Specifies how long to wait to a response from the destination before deciding that an error has occurred and canceling the transaction</td></tr><tr><td id="name"><strong>Batch Size</strong></td><td id="defaul
t-value">1000</td><td id="allowable-values"></td><td id="description">Specifies how many records to send in a single batch, at most.</td></tr><tr><td id="name"><strong>Transport Protocol</strong></td><td id="default-value">RAW</td><td id="allowable-values"><ul><li>RAW</li><li>HTTP</li></ul></td><td id="description">Specifies which transport protocol to use for Site-to-Site communication.</td></tr><tr><td id="name">HTTP Proxy hostname</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Specify the proxy server's hostname to use. If not specified, HTTP traffics are sent directly to the target NiFi instance.</td></tr><tr><td id="name">HTTP Proxy port</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Specify the proxy server's port number, optional. If not specified, default port 80 will be used.</td></tr><tr><td id="name">HTTP Proxy username</td><td id="default-value"></td><td id="allowable-values"></td><td id="descripti
on">Specify an user name to connect to the proxy server, optional.</td></tr><tr><td id="name">HTTP Proxy password</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Specify an user password to connect to the proxy server, optional.<br/><strong>Sensitive Property: true</strong></td></tr><tr><td id="name">Record Writer</td><td id="default-value"></td><td id="allowable-values"><strong>Controller Service API: </strong><br/>RecordSetWriterFactory<br/><strong>Implementations: </strong><a href="../../../nifi-parquet-nar/1.11.0/org.apache.nifi.parquet.ParquetRecordSetWriter/index.html">ParquetRecordSetWriter</a><br/><a href="../../../nifi-scripting-nar/1.11.0/org.apache.nifi.record.script.ScriptedRecordSetWriter/index.html">ScriptedRecordSetWriter</a><br/><a href="../../../nifi-record-serialization-services-nar/1.11.0/org.apache.nifi.text.FreeFormTextRecordSetWriter/index.html">FreeFormTextRecordSetWriter</a><br/><a href="../../../nifi-record-serialization-s
ervices-nar/1.11.0/org.apache.nifi.csv.CSVRecordSetWriter/index.html">CSVRecordSetWriter</a><br/><a href="../../../nifi-record-serialization-services-nar/1.11.0/org.apache.nifi.xml.XMLRecordSetWriter/index.html">XMLRecordSetWriter</a><br/><a href="../../../nifi-record-serialization-services-nar/1.11.0/org.apache.nifi.json.JsonRecordSetWriter/index.html">JsonRecordSetWriter</a><br/><a href="../../../nifi-record-serialization-services-nar/1.11.0/org.apache.nifi.avro.AvroRecordSetWriter/index.html">AvroRecordSetWriter</a></td><td id="description">Specifies the Controller Service to use for writing out the records.</td></tr><tr><td id="name"><strong>Include Null Values</strong></td><td id="default-value">false</td><td id="allowable-values"><ul><li>true</li><li>false</li></ul></td><td id="description">Indicate if null values should be included in records. Default will be false</td></tr><tr><td id="name"><strong>Platform</strong></td><td id="default-value">nifi</td><td id="allowable-value
s"></td><td id="description">The value to use for the platform field in each status record.<br/><strong>Supports Expression Language: true (will be evaluated using variable registry only)</strong></td></tr><tr><td id="name"><strong>Component Type Filter Regex</strong></td><td id="default-value">(Processor|ProcessGroup|RemoteProcessGroup|RootProcessGroup|Connection|InputPort|OutputPort)</td><td id="allowable-values"></td><td id="description">A regex specifying which component types to report. Any component type matching this regex will be included. Component types are: Processor, RootProcessGroup, ProcessGroup, RemoteProcessGroup, Connection, InputPort, OutputPort<br/><strong>Supports Expression Language: true (will be evaluated using variable registry only)</strong></td></tr><tr><td id="name"><strong>Component Name Filter Regex</strong></td><td id="default-value">.*</td><td id="allowable-values"></td><td id="description">A regex specifying which component names to report. Any com
ponent name matching this regex will be included.<br/><strong>Supports Expression Language: true (will be evaluated using variable registry only)</strong></td></tr></table><h3>State management: </h3>This component does not store state.<h3>Restricted: </h3>This component is not restricted.<h3>System Resource Considerations:</h3>None specified.</body></html>
\ No newline at end of file
Added: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-site-to-site-reporting-nar/1.11.0/org.apache.nifi.reporting.sink.SiteToSiteReportingRecordSink/index.html
URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-site-to-site-reporting-nar/1.11.0/org.apache.nifi.reporting.sink.SiteToSiteReportingRecordSink/index.html?rev=1873052&view=auto
==============================================================================
--- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-site-to-site-reporting-nar/1.11.0/org.apache.nifi.reporting.sink.SiteToSiteReportingRecordSink/index.html (added)
+++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-site-to-site-reporting-nar/1.11.0/org.apache.nifi.reporting.sink.SiteToSiteReportingRecordSink/index.html Thu Jan 23 03:48:17 2020
@@ -0,0 +1 @@
+<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>SiteToSiteReportingRecordSink</title><link rel="stylesheet" href="../../../../../css/component-usage.css" type="text/css"></link></head><script type="text/javascript">window.onload = function(){if(self==top) { document.getElementById('nameHeader').style.display = "inherit"; } }</script><body><h1 id="nameHeader" style="display: none;">SiteToSiteReportingRecordSink</h1><h2>Description: </h2><p>Provides a service to write records using a configured RecordSetWriter over a Site-to-Site connection.</p><h3>Tags: </h3><p>db, s2s, site, record</p><h3>Properties: </h3><p>In the list below, the names of required properties appear in <strong>bold</strong>. Any other properties (not in bold) are considered optional. The table also indicates any default values, whether a property supports the <a href="../../../../../html/expression-language-guide.html">NiFi Expression Language</a>, and whether a property is considered "sensi
tive", meaning that its value will be encrypted. Before entering a value in a sensitive property, ensure that the <strong>nifi.properties</strong> file has an entry for the property <strong>nifi.sensitive.props.key</strong>.</p><table id="properties"><tr><th>Name</th><th>Default Value</th><th>Allowable Values</th><th>Description</th></tr><tr><td id="name"><strong>Record Writer</strong></td><td id="default-value"></td><td id="allowable-values"><strong>Controller Service API: </strong><br/>RecordSetWriterFactory<br/><strong>Implementations: </strong><a href="../../../nifi-parquet-nar/1.11.0/org.apache.nifi.parquet.ParquetRecordSetWriter/index.html">ParquetRecordSetWriter</a><br/><a href="../../../nifi-scripting-nar/1.11.0/org.apache.nifi.record.script.ScriptedRecordSetWriter/index.html">ScriptedRecordSetWriter</a><br/><a href="../../../nifi-record-serialization-services-nar/1.11.0/org.apache.nifi.text.FreeFormTextRecordSetWriter/index.html">FreeFormTextRecordSetWriter</a><br/><a href=
"../../../nifi-record-serialization-services-nar/1.11.0/org.apache.nifi.csv.CSVRecordSetWriter/index.html">CSVRecordSetWriter</a><br/><a href="../../../nifi-record-serialization-services-nar/1.11.0/org.apache.nifi.xml.XMLRecordSetWriter/index.html">XMLRecordSetWriter</a><br/><a href="../../../nifi-record-serialization-services-nar/1.11.0/org.apache.nifi.json.JsonRecordSetWriter/index.html">JsonRecordSetWriter</a><br/><a href="../../../nifi-record-serialization-services-nar/1.11.0/org.apache.nifi.avro.AvroRecordSetWriter/index.html">AvroRecordSetWriter</a></td><td id="description">Specifies the Controller Service to use for writing out the records.</td></tr><tr><td id="name"><strong>Destination URL</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The URL of the destination NiFi instance or, if clustered, a comma-separated list of address in the format of http(s)://host:port/nifi. This destination URL will only be used to initiate the Site-t
o-Site connection. The data sent by this reporting task will be load-balanced on all the nodes of the destination (if clustered).<br/><strong>Supports Expression Language: true (will be evaluated using variable registry only)</strong></td></tr><tr><td id="name"><strong>Input Port Name</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The name of the Input Port to deliver data to.<br/><strong>Supports Expression Language: true (will be evaluated using variable registry only)</strong></td></tr><tr><td id="name">SSL Context Service</td><td id="default-value"></td><td id="allowable-values"><strong>Controller Service API: </strong><br/>RestrictedSSLContextService<br/><strong>Implementation: </strong><a href="../../../nifi-ssl-context-service-nar/1.11.0/org.apache.nifi.ssl.StandardRestrictedSSLContextService/index.html">StandardRestrictedSSLContextService</a></td><td id="description">The SSL Context Service to use when communicating with the dest
ination. If not specified, communications will not be secure.</td></tr><tr><td id="name"><strong>Instance URL</strong></td><td id="default-value">http://${hostname(true)}:8080/nifi</td><td id="allowable-values"></td><td id="description">The URL of this instance to use in the Content URI of each event.<br/><strong>Supports Expression Language: true (will be evaluated using variable registry only)</strong></td></tr><tr><td id="name"><strong>Compress Events</strong></td><td id="default-value">true</td><td id="allowable-values"><ul><li>true</li><li>false</li></ul></td><td id="description">Indicates whether or not to compress the data being sent.</td></tr><tr><td id="name"><strong>Communications Timeout</strong></td><td id="default-value">30 secs</td><td id="allowable-values"></td><td id="description">Specifies how long to wait to a response from the destination before deciding that an error has occurred and canceling the transaction</td></tr><tr><td id="name"><strong>Batch Size</strong>
</td><td id="default-value">1000</td><td id="allowable-values"></td><td id="description">Specifies how many records to send in a single batch, at most.</td></tr><tr><td id="name"><strong>Transport Protocol</strong></td><td id="default-value">RAW</td><td id="allowable-values"><ul><li>RAW</li><li>HTTP</li></ul></td><td id="description">Specifies which transport protocol to use for Site-to-Site communication.</td></tr><tr><td id="name">HTTP Proxy hostname</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Specify the proxy server's hostname to use. If not specified, HTTP traffics are sent directly to the target NiFi instance.</td></tr><tr><td id="name">HTTP Proxy port</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Specify the proxy server's port number, optional. If not specified, default port 80 will be used.</td></tr><tr><td id="name">HTTP Proxy username</td><td id="default-value"></td><td id="allowable-values"></t
d><td id="description">Specify an user name to connect to the proxy server, optional.</td></tr><tr><td id="name">HTTP Proxy password</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Specify an user password to connect to the proxy server, optional.<br/><strong>Sensitive Property: true</strong></td></tr></table><h3>State management: </h3>This component does not store state.<h3>Restricted: </h3>This component is not restricted.<h3>System Resource Considerations:</h3>None specified.</body></html>
\ No newline at end of file