Syslog 支持

Spring Integration 2.2 引入了 syslog 变换器：SyslogToMapTransformer。

您需要将此依赖项包含到您的项目中

  • Maven

  • Gradle

<dependency>
    <groupId>org.springframework.integration</groupId>
    <artifactId>spring-integration-syslog</artifactId>
    <version>6.3.0</version>
</dependency>
compile "org.springframework.integration:spring-integration-syslog:6.3.0"

此变换器与 UDP 或 TCP 入站适配器一起使用，可以用于接收和分析来自其他主机的 syslog 记录。变换器创建一个消息有效负载，其中包含来自 syslog 消息的元素的映射。

Spring Integration 3.0 引入了方便的命名空间支持，用于在一个元素中配置 syslog 入站适配器。

从 4.1.1 版本开始，框架现在支持扩展的 syslog 格式，如 RFC 5424> 中所述。此外，在使用 TCP 和 RFC5424 时，还支持 RFC 6587 中描述的 字节计数 和 非透明帧。

Syslog 入站通道适配器

此元素包含一个 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 版本开始，还支持 RFC 5424，方法是使用 RFC5424MessageConverter。在这种情况下，不会将字段复制为标头，除非将 asMap 设置为 false，在这种情况下，原始消息是有效负载，解码后的字段是标头。

要使用 RFC 5424 与 TCP 传输，您必须提供额外的配置以启用 RFC 6587 中描述的不同帧技术。适配器需要一个配置了 RFC6587SyslogDeserializer 的 TCP 连接工厂。默认情况下，此反序列化器使用换行符 (LF) 来分隔 syslog 消息，从而处理 字节计数 和 非透明帧。当未检测到 字节计数 时，它使用 ByteArrayLfSerializer。要使用不同的 非透明 帧，您可以为其提供一些其他反序列化器。虽然反序列化器可以支持 字节计数 和 非透明帧，但只支持后者的其中一种形式。如果转换器上的 asMap 为 false，则必须在 RFC6587SyslogDeserializer 中设置 retainOriginal 构造函数参数。

示例配置

以下示例定义了一个将消息发送到 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 入站通道适配器属性 中所定义。

当您使用 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-factory 必须是 server 类型，并且端口是在其中定义的，而不是在 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转换器，并配置了对外部定义的连接工厂的引用，该连接工厂使用RFC 6587反序列化器（RFC 5424 要求）。