martinzink commented on code in PR #1294:
URL: https://github.com/apache/nifi-minifi-cpp/pull/1294#discussion_r849458708


##########
PROCESSORS.md:
##########
@@ -1002,27 +1002,52 @@ In the list below, the names of required properties 
appear in bold. Any other pr
 
 ### Description
 
-Listens for Syslog messages being sent to a given port over TCP or UDP. 
Incoming messages are checked against regular expressions for RFC5424 and 
RFC3164 formatted messages. The format of each message is: (<PRIORITY>)(VERSION 
)(TIMESTAMP) (HOSTNAME) (BODY) where version is optional. 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 an incoming messages matches one of these 
patterns, the message will be parsed and the individual pieces will be placed 
in FlowFile attributes, with the original message in the content of the 
FlowFile. If an incoming message does not match one of these patterns it will 
not be parsed and the syslog.valid attribute will be set to false with the 
original message in the content of the FlowFile. Valid messages will be 
transferred on the success relationship, and invalid messages will be 
transferred on the invalid relat
 ionship.
+Listens for Syslog messages being sent to a given port over TCP or UDP.
+Incoming messages are optionally checked against regular expressions for 
RFC5424 and RFC3164 formatted messages.
+With parsing enabled the individual parts of the message will be placed as 
FlowFile attributes and valid messages will be transferred to success 
relationship, while invalid messages will be transferred to invalid 
relationship.
+With parsing disabled all message will be routed to the success relationship, 
but they will only contain the sender, protocol, and port attributes.
+
+
 ### Properties
 
 In the list below, the names of required properties appear in bold. Any other 
properties (not in bold) are considered optional. The table also indicates any 
default values, and whether a property supports the NiFi Expression Language.
 
-| Name | Default Value | Allowable Values | Description |
-| - | - | - | - |
-|Max Batch Size|1||The maximum number of Syslog events to add to a single 
FlowFile.|
-|Max Number of TCP Connections|2||The maximum number of concurrent connections 
to accept Syslog messages in TCP mode.|
-|Max Size of Socket Buffer|1 MB||The maximum size of the socket buffer that 
should be used.|
-|Message Delimiter|\n||Specifies the delimiter to place between Syslog 
messages when multiple messages are bundled together (see <Max Batch Size> 
core::Property).|
-|Parse Messages|false||Indicates if the processor should parse the Syslog 
messages. If set to false, each outgoing FlowFile will only.|
-|Port|514||The port for Syslog communication|
-|Protocol|UDP|UDP<br>TCP<br>|The protocol for Syslog communication.|
-|Receive Buffer Size|65507 B||The size of each buffer used to receive Syslog 
messages.|
+| Name                      | Default Value | Allowable Values | Description   
                                                                                
                                                                                
                       |
+|---------------------------|---------------|------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| Listening Port            | 514           |                  | The port for 
Syslog communication.                                                           
                                                                                
                        |

Review Comment:
   Good idea, I've changed it in 
https://github.com/apache/nifi-minifi-cpp/pull/1294/commits/251865e006f1e53e45c33fdaa184a9259f7bf13d



-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: issues-unsubscr...@nifi.apache.org

For queries about this service, please contact Infrastructure at:
us...@infra.apache.org

Reply via email to