Syslog Support

Spring Integration 2.2 引入了 syslog 变换器：SyslogToMapTransformer。你需要将此依赖项包含在你的项目中：

Maven
Gradle

<dependency>
    <groupId>org.springframework.integration</groupId>
    <artifactId>spring-integration-syslog</artifactId>
    <version>{project-version}</version>
</dependency>

compile "org.springframework.integration:spring-integration-syslog:{project-version}"

此变换器与“UDP”或“TCP”输入适配器一起可用于接收和分析来自其他主机的 syslog 记录。此变换器创建一个消息有效负载，其中包含来自 syslog 消息的元素映射。 Spring Integration 3.0 引入了方便的命名空间支持，可以在一个元素中配置 syslog 输入适配器。从 4.1.1 版本开始，框架现在支持 RFC 5424> 中指定的扩展 syslog 格式。此外，在使用 TCP 和 RFC5424 时， RFC 6587 中描述的 octet counting 和 non-transparent framing 都受支持。

Syslog Inbound Channel Adapter

此元素包括一个 UDP 或 TCP 入站通道适配器，以及一个 MessageConverter 来将 syslog 消息转换成 Spring Integration 消息。DefaultMessageConverter 委托给 SyslogToMapTransformer，创建一个消息，其有效负载是 syslog 字段的 Map。此外，除了消息以外的所有字段也都作为消息中的标头提供，并以 syslog_ 为前缀。在此模式中，仅支持 RFC 3164（BSD）syslog。

自 4.1 版起，DefaultMessageConverter 有一个名为 asMap 的属性（默认值为 true）。当它处于 false 状态时，转换器会将消息有效负载保留为原始的完整 syslog 消息（在 byte[] 中），同时仍然设置标头。

从 4.1.1 版本开始，还通过使用 RFC5424MessageConverter，支持 RFC 5424。在这种情况下，字段不会作为标头复制，除非已将 asMap 设置为 false，在这种情况下，原始消息是有效负载且已解码的字段是标头。

要将 RFC 5424 与 TCP 传输一起使用，您必须提供其他配置，以启用 RFC 6587 中描述的不同成帧技术。适配器需要使用 RFC6587SyslogDeserializer 配置的 TCP 连接工厂。默认情况下，此反序列化程序使用换行符 (LF) 界定系统日志消息，从而处理 octet counting 和 non-transparent framing。当未检测到 octet counting 时，它会使用 ByteArrayLfSerializer。要使用不同的 non-transparent 成帧，您可以为它提供其他反序列化程序。虽然反序列化程序可以同时支持 octet counting 和 non-transparent framing，但仅支持后者的一个形式。如果 asMap 在转换器上为 false，则必须在 RFC6587SyslogDeserializer 中设置 retainOriginal 构造函数参数。

Example Configuration

以下示例定义了一个将消息发送到 syslogIn 通道的 UDP 适配器（适配器 bean 名称是 syslogIn.adapter）：

<int-syslog:inbound-channel-adapter id="syslogIn" port="1514" />

该适配器在端口 1514 侦听。

以下示例定义了一个将消息发送到 fromSyslog 通道的 UDP 适配器（适配器 bean 名称是 syslogIn）：

<int-syslog:inbound-channel-adapter id="syslogIn"
	channel="fromSyslog" port="1514" />

该适配器在端口 1514 侦听。

以下示例定义了一个将消息发送到通道 syslogIn 的 TCP 适配器（适配器 bean 名称是 syslogIn.adapter）：

<int-syslog:inbound-channel-adapter id="bar" protocol="tcp" port="1514" />

该适配器在端口 1514 侦听。

请注意 protocol 属性的添加。此属性可以包含 udp 或 tcp。它默认为 udp。

以下示例显示了一个将消息发送到通道 fromSyslog 的 UDP 适配器：

<int-syslog:inbound-channel-adapter id="udpSyslog"
	channel="fromSyslog"
	auto-startup="false"
	phase="10000"
	converter="converter"
	send-timeout="1000"
	error-channel="errors">
		<int-syslog:udp-attributes port="1514" lookup-host="false" />
</int-syslog:inbound-channel-adapter>

前面的示例还展示了两个 SmartLifecycle 属性： auto-startup 和 phase。它引用一个自定义 org.springframework.integration.syslog.MessageConverter，其 ID 为 converter 和一个 error-channel。还请注意 udp-attributes 子元素。你可以在此设置各种 UDP 属性，如 .UDP Inbound Channel Adapter Attributes 中所定义的。

使用 udp-attributes 元素时，必须在 port 属性中提供，而不是在 inbound-channel-adapter 元素中提供。

以下示例显示了一个将消息发送到通道 fromSyslog 的 TCP 适配器：

<int-syslog:inbound-channel-adapter id="TcpSyslog"
	protocol="tcp"
	channel="fromSyslog"
	connection-factory="cf" />

<int-ip:tcp-connection-factory id="cf" type="server" port="1514" />

它还展示了如何引用外部定义的连接工厂，该连接工厂可用于高级配置（套接字保持活动和其他用途）。有关详细信息，请参阅 TCP Connection Factories。

外部配置的 connection-factory 必须为 server 类型，并且端口是在 connection-factory 中定义的，而不是在 inbound-channel-adapter 元素中定义的。

以下示例显示了一个将消息发送到通道 fromSyslog 的 TCP 适配器：

<int-syslog:inbound-channel-adapter id="rfc5424Tcp"
	protocol="tcp"
	channel="fromSyslog"
	connection-factory="cf"
	converter="rfc5424" />

<int-ip:tcp-connection-factory id="cf"
	using-nio="true"
	type="server"
	port="1514"
	deserializer="rfc6587" />

<bean id="rfc5424" class="org.springframework.integration.syslog.RFC5424MessageConverter" />

<bean id="rfc6587" class="org.springframework.integration.syslog.inbound.RFC6587SyslogDeserializer" />

前一个示例被配置为使用 RFC 5424 converter，并使用 RFC 6587 反序列化程序（RFC 5424 所需）引用外部定义的连接工厂进行配置。