Apache NiFi 2.x处理器:ListenSyslog 2.2.0

经验文章nimo972025-03-16 15:35:2710A⁺A^-

包

org.apache.nifi | nifi-standard-nar

描述

监听通过TCP或UDP发送到指定端口的Syslog消息。会根据RFC5424和RFC3164格式消息的正则表达式来检查传入消息。每条消息的格式为：()(VERSION )(TIMESTAMP) (HOSTNAME) (BODY) ，其中version是可选的。时间戳可以是RFC5424格式的“yyyy-MM-dd'T'HH:mm:ss.SZ” 或“yyyy-MM-dd'T'HH:mm:ss.S+hh:mm”，也可以是RFC3164格式的“MMM d HH:mm:ss”。如果传入消息与这些模式中的一种匹配，该消息将被解析，各个部分将被放置在FlowFile属性中，原始消息则存于FlowFile的内容中。如果传入消息与这些模式均不匹配，则不会被解析，syslog.valid属性将被设置为false，原始消息存于FlowFile的内容中。有效消息将通过success关系传输，无效消息将通过invalid关系传输。

输入要求

禁止

支持敏感的动态属性

否

属性

Character Set：指定Syslog消息的字符集。请注意，表达式语言不会针对每个FlowFile进行求值。

显示名称：Character Set
描述：指定Syslog消息的字符集。请注意，表达式语言不会针对每个FlowFile进行求值。
API名称：Character Set
默认值：UTF-8
表达式语言作用域：JVM级别定义的环境变量和系统属性
敏感：否
是否必需：是

Client Auth：用于SSL上下文的客户端认证策略。仅在提供SSL上下文服务时使用。

显示名称：Client Auth
描述：用于SSL上下文的客户端认证策略。仅在提供SSL上下文服务时使用。
API名称：Client Auth
默认值：REQUIRED
允许值：WANT、REQUIRED、NONE
表达式语言作用域：不支持
敏感：否
是否必需：否
依赖项：SSL Context Service设置为任何指定的值

Local Network Interface：用于将监听限制在特定局域网的本地网络接口名称。

显示名称：Local Network Interface
描述：用于将监听限制在特定局域网的本地网络接口名称。
API名称：Local Network Interface
表达式语言作用域：JVM级别定义的环境变量和系统属性
敏感：否
是否必需：否

Max Batch Size：添加到单个FlowFile中的最大Syslog事件数。如果有多个事件可用，它们将与一起连接，最多达到此配置的最大消息数。

显示名称：Max Batch Size
描述：添加到单个FlowFile中的最大Syslog事件数。如果有多个事件可用，它们将与一起连接，最多达到此配置的最大消息数。
API名称：Max Batch Size
默认值：1
表达式语言作用域：不支持
敏感：否
是否必需：是

Max Number of TCP Connections：在TCP模式下接受Syslog消息的最大并发连接数。

显示名称：Max Number of TCP Connections
描述：在TCP模式下接受Syslog消息的最大并发连接数。
API名称：Max Number of TCP Connections
默认值：2
表达式语言作用域：不支持
敏感：否
是否必需：是
依赖项：Protocol设置为[TCP]中的任何一个

Max Size of Message Queue：用于缓冲从底层通道传输到处理器的消息的内部队列的最大大小。将此值设置得更高可以在传入消息激增时在内存中缓冲更多消息，但会增加处理器使用的总内存。

显示名称：Max Size of Message Queue
描述：用于缓冲从底层通道传输到处理器的消息的内部队列的最大大小。将此值设置得更高可以在传入消息激增时在内存中缓冲更多消息，但会增加处理器使用的总内存。
API名称：Max Size of Message Queue
默认值：10000
表达式语言作用域：不支持
敏感：否
是否必需：是

Max Size of Socket Buffer：应使用的套接字缓冲区的最大大小。这是向操作系统建议的套接字缓冲区大小。如果此值设置得过低，缓冲区可能在数据读取之前就被填满，传入的数据将被丢弃。

显示名称：Max Size of Socket Buffer
描述：应使用的套接字缓冲区的最大大小。这是向操作系统建议的套接字缓冲区大小。如果此值设置得过低，缓冲区可能在数据读取之前就被填满，传入的数据将被丢弃。
API名称：Max Size of Socket Buffer
默认值：1 MB
表达式语言作用域：不支持
敏感：否
是否必需：是
依赖项：Protocol设置为[TCP]中的任何一个

Message Delimiter：指定在多个Syslog消息捆绑在一起时（请参阅属性）放置在消息之间的分隔符。

显示名称：Message Delimiter
描述：指定在多个Syslog消息捆绑在一起时（请参阅属性）放置在消息之间的分隔符。
API名称：Message Delimiter
默认值：\n
表达式语言作用域：不支持
敏感：否
是否必需：是

Parse Messages：指示处理器是否应解析Syslog消息。如果设置为false，每个传出的FlowFile将仅包含发送者、协议和端口，且没有其他属性。

显示名称：Parse Messages
描述：指示处理器是否应解析Syslog消息。如果设置为false，每个传出的FlowFile将仅包含发送者、协议和端口，且没有其他属性。
API名称：Parse Messages
默认值：true
允许值：true、false
表达式语言作用域：不支持
敏感：否
是否必需：是

Port：用于Syslog通信的端口。请注意，表达式语言不会针对每个FlowFile进行求值。

显示名称：Port
描述：用于Syslog通信的端口。请注意，表达式语言不会针对每个FlowFile进行求值。
API名称：Port
表达式语言作用域：JVM级别定义的环境变量和系统属性
敏感：否
是否必需：是

Protocol：用于Syslog通信的协议。

显示名称：Protocol
描述：用于Syslog通信的协议。
API名称：Protocol
默认值：UDP
允许值：TCP、UDP
表达式语言作用域：不支持
敏感：否
是否必需：是

Receive Buffer Size：用于接收Syslog消息的每个缓冲区的大小。根据预期传入的Syslog消息的大小适当调整此值。选择UDP时，每个缓冲区将容纳一条Syslog消息。选择TCP时，将从传入连接读取消息，直到缓冲区已满或连接关闭。

显示名称：Receive Buffer Size
描述：用于接收Syslog消息的每个缓冲区的大小。根据预期传入的Syslog消息的大小适当调整此值。选择UDP时，每个缓冲区将容纳一条Syslog消息。选择TCP时，将从传入连接读取消息，直到缓冲区已满或连接关闭。
API名称：Receive Buffer Size
默认值：65507 B
表达式语言作用域：不支持
敏感：否
是否必需：是

Socket Keep Alive：是否启用TCP套接字的保活功能。具体时间取决于操作系统属性。

显示名称：Socket Keep Alive
描述：是否启用TCP套接字的保活功能。具体时间取决于操作系统属性。
API名称：socket-keep-alive
默认值：false
允许值：true、false
表达式语言作用域：不支持
敏感：否
是否必需：是
依赖项：Protocol设置为[TCP]中的任何一个

SSL Context Service：用于获取SSL上下文的控制器服务。如果设置了此属性，Syslog消息将通过安全连接接收。

显示名称：SSL Context Service
描述：用于获取SSL上下文的控制器服务。如果设置了此属性，Syslog消息将通过安全连接接收。
API名称：SSL Context Service
服务接口：org.apache.nifi.ssl.SSLContextProvider
服务实现：org.apache.nifi.ssl.PEMEncodedSSLContextProvider、org.apache.nifi.ssl.StandardRestrictedSSLContextService、org.apache.nifi.ssl.StandardSSLContextService
表达式语言作用域：不支持
敏感：否
是否必需：否
依赖项：Protocol设置为[TCP]中的任何一个

关系

名称	描述
success	与预期格式之一匹配的Syslog消息将作为每个消息一个FlowFile通过此关系发送出去。
invalid	与预期格式均不匹配的Syslog消息将作为每个消息一个FlowFile通过此关系发送出去。

写入属性

名称	描述
syslog.priority	Syslog消息的优先级。
syslog.severity	从优先级派生的Syslog消息的严重程度。
syslog.facility	从优先级派生的Syslog消息的设施。
syslog.version	Syslog消息中的可选版本。
syslog.timestamp	Syslog消息的时间戳。
syslog.hostname	Syslog消息的主机名或IP地址。
syslog.sender	发送消息的Syslog服务器的主机名。
syslog.body	Syslog消息的正文，即主机名之后的所有内容。
syslog.valid	指示此消息是否与预期格式匹配。如果此值为false，其他属性将为空，内容中仅提供原始消息。
syslog.protocol	接收Syslog消息所使用的协议。
syslog.port	接收Syslog消息所使用的端口。
mime.type	FlowFile的mime.type，对于Syslog消息将是text/plain。