Modified: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.standard.PutSyslog/index.html URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.standard.PutSyslog/index.html?rev=1730777&r1=1730776&r2=1730777&view=diff ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.standard.PutSyslog/index.html (original) +++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.standard.PutSyslog/index.html Wed Feb 17 02:20:53 2016 @@ -1 +1 @@ -<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>PutSyslog</title><link rel="stylesheet" href="../../css/component-usage.css" type="text/css"></link></head><body><h2>Description: </h2><p>Sends Syslog messages to a given host and port over TCP or UDP. Messages are constructed from the "Message ___" properties of the processor which can use expression language to generate messages from incoming FlowFiles. The properties are used to construct messages of the form: (<PRIORITY>)(VERSION )(TIMESTAMP) (HOSTNAME) (BODY) where version is optional. The constructed messages are checked against regular expressions for RFC5424 and RFC3164 formatted messages. The timestamp can be an RFC5424 timestamp with a format of "yyyy-MM-dd'T'HH:mm:ss.SZ" or "yyyy-MM-dd'T'HH:mm:ss.S+hh:mm", or it can be an RFC3164 timestamp with a format of "MMM d HH:mm:ss". If a message is constructed that does not form a valid Syslog message according to the above description, then it is rout ed to the invalid relationship. Valid messages are sent to the Syslog server and successes are routed to the success relationship, failures routed to the failure relationship.</p><h3>Tags: </h3><p>syslog, put, udp, tcp, logs</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>Hostname</strong></td><td id="default-value">localhost</td><td id="allowable-values"></td><td id="description">The ip address or hostname of the Syslog server.</td></tr><tr><td id="name"><strong>Protocol</strong></td><td id="default-value">UDP</td><td id="allowable-values"><ul><li>TCP</li><li>UD P</li></ul></td><td id="description">The protocol for Syslog communication, either TCP or UDP.</td></tr><tr><td id="name"><strong>Port</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The port for Syslog communication.</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/>SSLContextService<br/><strong>Implementation:</strong><br/><a href="../org.apache.nifi.ssl.StandardSSLContextService/index.html">StandardSSLContextService</a></td><td id="description">The Controller Service to use in order to obtain an SSL Context. If this property is set, syslog messages will be sent over a secure connection.</td></tr><tr><td id="name"><strong>Idle Connection Expiration</strong></td><td id="default-value">5 seconds</td><td id="allowable-values"></td><td id="description">The amount of time a connection should be held open without being used before closing the connection.</td></tr><tr><td id="name"><strong>Send Buffer Size</strong></td><td id="default-value">2048 B</td><td id="allowable-values"></td><td id="description">The size of each buffer used to send a Syslog message. Adjust this value appropriately based on the expected size of the Syslog messages being produced. Messages larger than this buffer size will still be sent, but will not make use of the buffer pool.</td></tr><tr><td id="name"><strong>Batch Size</strong></td><td id="default-value">25</td><td id="allowable-values"></td><td id="description">The number of incoming FlowFiles to process in a single execution of this processor.</td></tr><tr><td id="name"><strong>Character Set</strong></td><td id="default-value">UTF-8</td><td id="allowable-values"></td><td id="description">Specifies which character set of the Syslog messages</td></tr><tr><td id="name"><strong>Message Priority</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The priori ty for the Syslog messages, excluding < >.<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name">Message Version</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The version for the Syslog messages.<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name"><strong>Message Timestamp</strong></td><td id="default-value">${now():format('MMM d HH:mm:ss')}</td><td id="allowable-values"></td><td id="description">The timestamp for the Syslog messages. The timestamp can be an RFC5424 timestamp with a format of "yyyy-MM-dd'T'HH:mm:ss.SZ" or "yyyy-MM-dd'T'HH:mm:ss.S+hh:mm", " or it can be an RFC3164 timestamp with a format of "MMM d HH:mm:ss".<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name"><strong>Message Hostname</strong></td><td id="default-value">${hostname(true)}</td><td id="allowable-values"></td><td id="description">The hostname for the Syslog messages.<br/>< strong>Supports Expression Language: true</strong></td></tr><tr><td id="name"><strong>Message Body</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The body for the Syslog messages.<br/><strong>Supports Expression Language: true</strong></td></tr></table><h3>Relationships: </h3><table id="relationships"><tr><th>Name</th><th>Description</th></tr><tr><td>success</td><td>FlowFiles that are sent successfully to Syslog are sent out this relationship.</td></tr><tr><td>failure</td><td>FlowFiles that failed to send to Syslog are sent out this relationship.</td></tr><tr><td>invalid</td><td>FlowFiles that do not form a valid Syslog message are sent out this relationship.</td></tr></table><h3>Reads Attributes: </h3>None specified.<h3>Writes Attributes: </h3>None specified.<h3>See Also:</h3><p><a href="../org.apache.nifi.processors.standard.ListenSyslog/index.html">ListenSyslog</a>, <a href="../org.apache.nifi.processors.standard.ParseSyslog/index.htm l">ParseSyslog</a></p></body></html> \ No newline at end of file +<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>PutSyslog</title><link rel="stylesheet" href="../../css/component-usage.css" type="text/css"></link></head><body><h2>Description: </h2><p>Sends Syslog messages to a given host and port over TCP or UDP. Messages are constructed from the "Message ___" properties of the processor which can use expression language to generate messages from incoming FlowFiles. The properties are used to construct messages of the form: (<PRIORITY>)(VERSION )(TIMESTAMP) (HOSTNAME) (BODY) where version is optional. The constructed messages are checked against regular expressions for RFC5424 and RFC3164 formatted messages. The timestamp can be an RFC5424 timestamp with a format of "yyyy-MM-dd'T'HH:mm:ss.SZ" or "yyyy-MM-dd'T'HH:mm:ss.S+hh:mm", or it can be an RFC3164 timestamp with a format of "MMM d HH:mm:ss". If a message is constructed that does not form a valid Syslog message according to the above description, then it is rout ed to the invalid relationship. Valid messages are sent to the Syslog server and successes are routed to the success relationship, failures routed to the failure relationship.</p><h3>Tags: </h3><p>syslog, put, udp, tcp, logs</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>Hostname</strong></td><td id="default-value">localhost</td><td id="allowable-values"></td><td id="description">The ip address or hostname of the Syslog server.</td></tr><tr><td id="name"><strong>Protocol</strong></td><td id="default-value">UDP</td><td id="allowable-values"><ul><li>TCP</li><li>UD P</li></ul></td><td id="description">The protocol for Syslog communication.</td></tr><tr><td id="name"><strong>Port</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The port for Syslog communication.</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/>SSLContextService<br/><strong>Implementation:</strong><br/><a href="../org.apache.nifi.ssl.StandardSSLContextService/index.html">StandardSSLContextService</a></td><td id="description">The Controller Service to use in order to obtain an SSL Context. If this property is set, syslog messages will be sent over a secure connection.</td></tr><tr><td id="name"><strong>Idle Connection Expiration</strong></td><td id="default-value">5 seconds</td><td id="allowable-values"></td><td id="description">The amount of time a connection should be held open without being used before closing the connection.</td></t r><tr><td id="name"><strong>Send Buffer Size</strong></td><td id="default-value">2048 B</td><td id="allowable-values"></td><td id="description">The size of each buffer used to send a Syslog message. Adjust this value appropriately based on the expected size of the Syslog messages being produced. Messages larger than this buffer size will still be sent, but will not make use of the buffer pool.</td></tr><tr><td id="name"><strong>Batch Size</strong></td><td id="default-value">25</td><td id="allowable-values"></td><td id="description">The number of incoming FlowFiles to process in a single execution of this processor.</td></tr><tr><td id="name"><strong>Character Set</strong></td><td id="default-value">UTF-8</td><td id="allowable-values"></td><td id="description">Specifies the character set of the Syslog messages</td></tr><tr><td id="name"><strong>Message Priority</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The priority for the Syslog mes sages, excluding < >.<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name">Message Version</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The version for the Syslog messages.<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name"><strong>Message Timestamp</strong></td><td id="default-value">${now():format('MMM d HH:mm:ss')}</td><td id="allowable-values"></td><td id="description">The timestamp for the Syslog messages. The timestamp can be an RFC5424 timestamp with a format of "yyyy-MM-dd'T'HH:mm:ss.SZ" or "yyyy-MM-dd'T'HH:mm:ss.S+hh:mm", " or it can be an RFC3164 timestamp with a format of "MMM d HH:mm:ss".<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name"><strong>Message Hostname</strong></td><td id="default-value">${hostname(true)}</td><td id="allowable-values"></td><td id="description">The hostname for the Syslog messages.<br/><strong>Supports Expre ssion Language: true</strong></td></tr><tr><td id="name"><strong>Message Body</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The body for the Syslog messages.<br/><strong>Supports Expression Language: true</strong></td></tr></table><h3>Relationships: </h3><table id="relationships"><tr><th>Name</th><th>Description</th></tr><tr><td>success</td><td>FlowFiles that are sent successfully to Syslog are sent out this relationship.</td></tr><tr><td>failure</td><td>FlowFiles that failed to send to Syslog are sent out this relationship.</td></tr><tr><td>invalid</td><td>FlowFiles that do not form a valid Syslog message are sent out this relationship.</td></tr></table><h3>Reads Attributes: </h3>None specified.<h3>Writes Attributes: </h3>None specified.<h3>See Also:</h3><p><a href="../org.apache.nifi.processors.standard.ListenSyslog/index.html">ListenSyslog</a>, <a href="../org.apache.nifi.processors.standard.ParseSyslog/index.html">ParseSyslog</a></p ></body></html> \ No newline at end of file
Modified: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.standard.TailFile/index.html URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.standard.TailFile/index.html?rev=1730777&r1=1730776&r2=1730777&view=diff ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.standard.TailFile/index.html (original) +++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.standard.TailFile/index.html Wed Feb 17 02:20:53 2016 @@ -1 +1 @@ -<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>TailFile</title><link rel="stylesheet" href="../../css/component-usage.css" type="text/css"></link></head><body><h2>Description: </h2><p>"Tails" a file, ingesting data from the file as it is written to the file. The file is expected to be textual. Data is ingested only when a new line is encountered (carriage return or new-line character or combination). If the file to tail is periodically "rolled over", as is generally the case with log files, an optional Rolling Filename Pattern can be used to retrieve data from files that have rolled over, even if the rollover occurred while NiFi was not running (provided that the data still exists upon restart of NiFi). It is generally advisable to set the Run Schedule to a few seconds, rather than running with the default value of 0 secs, as this Processor will consume a lot of resources if scheduled very aggressively. At this time, this Processor does not support ingestin g files that have been compressed when 'rolled over'.</p><h3>Tags: </h3><p>tail, file, log, text, source</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.</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>File to Tail</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Fully-qualified filename of the file that should be tailed</td></tr><tr><td id="name">Rolling Filename Pattern</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">If the file to tail "rolls over" as would be the case with log files, this filename pattern will be used to identify files that have rolled over so that if NiFi is restarted, and the file has rolled over, it will be able to pick up w here it left off. This pattern supports wildcard characters * and ? and will assume that the files that have rolled over live in the same directory as the file being tailed.</td></tr><tr><td id="name"><strong>State File</strong></td><td id="default-value">./conf/state/mock-processor</td><td id="allowable-values"></td><td id="description">Specifies the file that should be used for storing state about what data has been ingested so that upon restart NiFi can resume from where it left off</td></tr><tr><td id="name"><strong>Initial Start Position</strong></td><td id="default-value">Beginning of File</td><td id="allowable-values"><ul><li>Beginning of Time <img src="../../html/images/iconInfo.png" alt="Start with the oldest data that matches the Rolling Filename Pattern and then begin reading from the File to Tail" title="Start with the oldest data that matches the Rolling Filename Pattern and then begin reading from the File to Tail"></img></li><li>Beginning of File <img src="../../html/ images/iconInfo.png" alt="Start with the beginning of the File to Tail. Do not ingest any data that has already been rolled over" title="Start with the beginning of the File to Tail. Do not ingest any data that has already been rolled over"></img></li><li>Current Time <img src="../../html/images/iconInfo.png" alt="Start with the data at the end of the File to Tail. Do not ingest any data thas has already been rolled over or any data in the File to Tail that has already been written." title="Start with the data at the end of the File to Tail. Do not ingest any data thas has already been rolled over or any data in the File to Tail that has already been written."></img></li></ul></td><td id="description">When the Processor first begins to tail data, this property specifies where the Processor should begin reading data. Once data has been ingested from the file, the Processor will continue from the last point from which it has received data.</td></tr></table><h3>Relationships: </h3><tab le id="relationships"><tr><th>Name</th><th>Description</th></tr><tr><td>success</td><td>All FlowFiles are routed to this Relationship.</td></tr></table><h3>Reads Attributes: </h3>None specified.<h3>Writes Attributes: </h3>None specified.</body></html> \ No newline at end of file +<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>TailFile</title><link rel="stylesheet" href="../../css/component-usage.css" type="text/css"></link></head><body><h2>Description: </h2><p>"Tails" a file, ingesting data from the file as it is written to the file. The file is expected to be textual. Data is ingested only when a new line is encountered (carriage return or new-line character or combination). If the file to tail is periodically "rolled over", as is generally the case with log files, an optional Rolling Filename Pattern can be used to retrieve data from files that have rolled over, even if the rollover occurred while NiFi was not running (provided that the data still exists upon restart of NiFi). It is generally advisable to set the Run Schedule to a few seconds, rather than running with the default value of 0 secs, as this Processor will consume a lot of resources if scheduled very aggressively. At this time, this Processor does not support ingestin g files that have been compressed when 'rolled over'.</p><h3>Tags: </h3><p>tail, file, log, text, source</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.</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>File to Tail</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Fully-qualified filename of the file that should be tailed</td></tr><tr><td id="name">Rolling Filename Pattern</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">If the file to tail "rolls over" as would be the case with log files, this filename pattern will be used to identify files that have rolled over so that if NiFi is restarted, and the file has rolled over, it will be able to pick up w here it left off. This pattern supports wildcard characters * and ? and will assume that the files that have rolled over live in the same directory as the file being tailed.</td></tr><tr><td id="name">State File</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Specifies the file that should be used for storing state about what data has been ingested so that upon restart NiFi can resume from where it left off</td></tr><tr><td id="name"><strong>Initial Start Position</strong></td><td id="default-value">Beginning of File</td><td id="allowable-values"><ul><li>Beginning of Time <img src="../../html/images/iconInfo.png" alt="Start with the oldest data that matches the Rolling Filename Pattern and then begin reading from the File to Tail" title="Start with the oldest data that matches the Rolling Filename Pattern and then begin reading from the File to Tail"></img></li><li>Beginning of File <img src="../../html/images/iconInfo.png" alt="Start with the beg inning of the File to Tail. Do not ingest any data that has already been rolled over" title="Start with the beginning of the File to Tail. Do not ingest any data that has already been rolled over"></img></li><li>Current Time <img src="../../html/images/iconInfo.png" alt="Start with the data at the end of the File to Tail. Do not ingest any data thas has already been rolled over or any data in the File to Tail that has already been written." title="Start with the data at the end of the File to Tail. Do not ingest any data thas has already been rolled over or any data in the File to Tail that has already been written."></img></li></ul></td><td id="description">When the Processor first begins to tail data, this property specifies where the Processor should begin reading data. Once data has been ingested from the file, the Processor will continue from the last point from which it has received data.</td></tr><tr><td id="name"><strong>File Location</strong></td><td id="default-value">Loca l</td><td id="allowable-values"><ul><li>Local <img src="../../html/images/iconInfo.png" alt="File is located on a local disk drive. Each node in a cluster will tail a different file." title="File is located on a local disk drive. Each node in a cluster will tail a different file."></img></li><li>Remote <img src="../../html/images/iconInfo.png" alt="File is located on a remote resource. This Processor will store state across the cluster so that it can be run on Primary Node Only and a new Primary Node can pick up where the last one left off." title="File is located on a remote resource. This Processor will store state across the cluster so that it can be run on Primary Node Only and a new Primary Node can pick up where the last one left off."></img></li></ul></td><td id="description">Specifies where the file is located, so that state can be stored appropriately in order to ensure that all data is consumed without duplicating data upon restart of NiFi</td></tr></table><h3>Relationship s: </h3><table id="relationships"><tr><th>Name</th><th>Description</th></tr><tr><td>success</td><td>All FlowFiles are routed to this Relationship.</td></tr></table><h3>Reads Attributes: </h3>None specified.<h3>Writes Attributes: </h3>None specified.</body></html> \ No newline at end of file