此版本仍在开发中，尚不被认为是稳定的。对于最新的稳定版本，请使用 Spring AMQP 3.2.6！spring-doc.cadn.net.cn

日志记录子系统 AMQP 附加器

该框架为一些流行的日志记录子系统提供了日志记录附加程序：spring-doc.cadn.net.cn

附加程序是使用日志记录子系统的正常机制配置的，可用属性在以下部分中指定。spring-doc.cadn.net.cn

常见属性

以下属性可用于所有附加器：spring-doc.cadn.net.cn

表 1.常见附加器属性
属性 默认值 描述 
 exchangeName
 
 logs

要向其发布日志事件的交换的名称。spring-doc.cadn.net.cn

 
 exchangeType
 
 topic

要向其发布日志事件的交换类型 — 仅当附加者声明交换时才需要。 看declareExchange.spring-doc.cadn.net.cn

 
 routingKeyPattern
 
 %c.%p

用于生成路由密钥的日志记录子系统模式格式。spring-doc.cadn.net.cn

 
 applicationId
 


应用程序 ID — 如果模式包括%X{applicationId}.spring-doc.cadn.net.cn






 senderPoolSize


 2


用于发布日志事件的线程数。spring-doc.cadn.net.cn






 maxSenderRetries


 30


如果代理不可用或存在其他错误，则重试发送消息的次数。
重试延迟如下：N ^ log(N)哪里N是重试次数。spring-doc.cadn.net.cn






 addresses




以逗号分隔的代理地址列表，格式如下：host:port[,host:port]*-重写host和port.spring-doc.cadn.net.cn






 host


 localhost


RabbitMQ 主机 。spring-doc.cadn.net.cn






 port


 5672


要连接的 RabbitMQ 端口。spring-doc.cadn.net.cn






 virtualHost


 /


要连接的 RabbitMQ 虚拟主机。spring-doc.cadn.net.cn






 username


 guest


RabbitMQ 用户。spring-doc.cadn.net.cn






 password


 guest


此用户的 RabbitMQ 密码。spring-doc.cadn.net.cn






 useSsl


 false


是否对 RabbitMQ 连接使用 SSL。
看RabbitConnectionFactoryBean和配置 SSLspring-doc.cadn.net.cn






 verifyHostname


 true


为 TLS 连接启用服务器主机名验证。
看RabbitConnectionFactoryBean和配置 SSLspring-doc.cadn.net.cn






 sslAlgorithm


 null


要使用的 SSL 算法。spring-doc.cadn.net.cn






 sslPropertiesLocation


 null


SSL 属性文件的位置。spring-doc.cadn.net.cn






 keyStore


 null


密钥库的位置。spring-doc.cadn.net.cn






 keyStorePassphrase


 null


密钥库的密码。spring-doc.cadn.net.cn






 keyStoreType


 JKS


密钥库类型。spring-doc.cadn.net.cn






 trustStore


 null


信任存储的位置。spring-doc.cadn.net.cn






 trustStorePassphrase


 null


信任库的密码。spring-doc.cadn.net.cn






 trustStoreType


 JKS


信任库类型。spring-doc.cadn.net.cn






 saslConfig


 null (RabbitMQ client default applies)


这saslConfig- 请参阅 JavadocRabbitUtils.stringToSaslConfig对于有效值。spring-doc.cadn.net.cn






 contentType


 text/plain


content-type日志消息的属性。spring-doc.cadn.net.cn






 contentEncoding




content-encoding日志消息的属性。spring-doc.cadn.net.cn






 declareExchange


 false


是否在此附加器启动时声明已配置的交换。
也可以看看durable和autoDelete.spring-doc.cadn.net.cn






 durable


 true


什么时候declareExchange是true，则持久标志设置为此值。spring-doc.cadn.net.cn






 autoDelete


 false


什么时候declareExchange是true，则自动删除标志设置为此值。spring-doc.cadn.net.cn






 charset


 null


转换时要使用的字符集String自byte[]. 默认值：null（使用系统默认字符集）。如果当前平台上不支持该字符集，我们回退到使用系统字符集。spring-doc.cadn.net.cn






 deliveryMode


 PERSISTENT


PERSISTENT或NON_PERSISTENT以确定 RabbitMQ 是否应该持久化消息。spring-doc.cadn.net.cn






 generateId


 false


用于确定messageId属性设置为唯一值。spring-doc.cadn.net.cn






 clientConnectionProperties


 null


以逗号分隔的列表key:value自定义客户端属性与 RabbitMQ 连接的配对。spring-doc.cadn.net.cn






 addMdcAsHeaders


 true


在引入此属性之前，MDC 属性始终被添加到 RabbitMQ 消息标头中。它可能会导致大 MDC 出现问题，因为 RabbitMQ 对所有标头的缓冲区大小有限，而且这个缓冲区非常小。引入此属性是为了避免在大 MDC 的情况下出现问题。默认情况下，此值设置为true用于向后兼容性。 这false关闭序列化 MDC 到标头。请注意，JsonLayout默认情况下，将 MDC 添加到邮件中。spring-doc.cadn.net.cn













Log4j 2 附加器






以下示例显示了如何配置 Log4j 2 附加器：spring-doc.cadn.net.cn








<Appenders>
    ...
    <RabbitMQ name="rabbitmq"
        addresses="foo:5672,bar:5672" user="guest" password="guest" virtualHost="/"
        exchange="log4j2" exchangeType="topic" declareExchange="true" durable="true" autoDelete="false"
        applicationId="myAppId" routingKeyPattern="%X{applicationId}.%c.%p"
        contentType="text/plain" contentEncoding="UTF-8" generateId="true" deliveryMode="NON_PERSISTENT"
        charset="UTF-8"
        senderPoolSize="3" maxSenderRetries="5"
        addMdcAsHeaders="false">
    </RabbitMQ>
</Appenders>


















从版本 1.6.10 和 1.7.3 开始，默认情况下，log4j2 附加器将消息发布到调用线程上的 RabbitMQ。这是因为默认情况下，Log4j 2 不会创建线程安全事件。如果代理关闭，则maxSenderRetries用于重试，重试之间没有延迟。如果您希望恢复以前在单独线程（senderPoolSize），您可以将async属性设置为true. 但是，您还需要配置 Log4j 2 以使用DefaultLogEventFactory而不是ReusableLogEventFactory. 一种方法是设置系统属性-Dlog4j2.enable.threadlocals=false. 如果您将异步发布与ReusableLogEventFactory，事件很有可能因串扰而被破坏。spring-doc.cadn.net.cn

















Logback Appender






以下示例显示了如何配置 logback 附加器：spring-doc.cadn.net.cn








<appender name="AMQP" class="org.springframework.amqp.rabbit.logback.AmqpAppender">
    <layout>
        <pattern><![CDATA[ %d %p %t [%c] - <%m>%n ]]></pattern>
    </layout>
    <addresses>foo:5672,bar:5672</addresses>
    <abbreviation>36</abbreviation>
    <includeCallerData>false</includeCallerData>
    <applicationId>myApplication</applicationId>
    <routingKeyPattern>%property{applicationId}.%c.%p</routingKeyPattern>
    <generateId>true</generateId>
    <charset>UTF-8</charset>
    <durable>false</durable>
    <deliveryMode>NON_PERSISTENT</deliveryMode>
    <declareExchange>true</declareExchange>
    <addMdcAsHeaders>false</addMdcAsHeaders>
</appender>








从 1.7.1 版本开始，LogbackAmqpAppender提供includeCallerData选项，即false默认情况下。提取调用方数据可能相当昂贵，因为日志事件必须创建一个可抛出项并检查它以确定调用位置。因此，默认情况下，当事件添加到事件队列时，不会提取与事件关联的调用方数据。您可以通过将includeCallerData属性设置为true.spring-doc.cadn.net.cn






从 2.0.0 版本开始，LogbackAmqpAppender支持 Logback 编码器，其中包含encoder选择。 这encoder和layout选项是相互排斥的。spring-doc.cadn.net.cn










自定义消息






默认情况下，AMQP 附加器填充以下消息属性：spring-doc.cadn.net.cn











此外，它们还使用以下值填充标头：spring-doc.cadn.net.cn











每个附加器都可以进行子类化，以便您在发布之前修改消息。
以下示例演示如何自定义日志消息：spring-doc.cadn.net.cn








public class MyEnhancedAppender extends AmqpAppender {

    @Override
    public Message postProcessMessageBeforeSend(Message message, Event event) {
        message.getMessageProperties().setHeader("foo", "bar");
        return message;
    }

}








从 2.2.4 开始，log4j2AmqpAppender可以使用@PluginBuilderFactory并扩展AmqpAppender.Builderspring-doc.cadn.net.cn








@Plugin(name = "MyEnhancedAppender", category = "Core", elementType = "appender", printObject = true)
public class MyEnhancedAppender extends AmqpAppender {

	public MyEnhancedAppender(String name, Filter filter, Layout<? extends Serializable> layout,
			boolean ignoreExceptions, AmqpManager manager, BlockingQueue<Event> eventQueue, String foo, String bar) {
		super(name, filter, layout, ignoreExceptions, manager, eventQueue);

	@Override
	public Message postProcessMessageBeforeSend(Message message, Event event) {
			message.getMessageProperties().setHeader("foo", "bar");
		return message;
	}

	@PluginBuilderFactory
	public static Builder newBuilder() {
		return new Builder();
	}

	protected static class Builder extends AmqpAppender.Builder {

		@Override
		protected AmqpAppender buildInstance(String name, Filter filter, Layout<? extends Serializable> layout,
				boolean ignoreExceptions, AmqpManager manager, BlockingQueue<Event> eventQueue) {
			return new MyEnhancedAppender(name, filter, layout, ignoreExceptions, manager, eventQueue);
		}
	}

}












自定义客户端属性






可以通过添加字符串属性或更复杂的属性来添加自定义客户端属性。spring-doc.cadn.net.cn






简单字符串属性




每个附加器都支持将客户端属性添加到 RabbitMQ 连接。spring-doc.cadn.net.cn






以下示例演示如何添加自定义客户端属性：spring-doc.cadn.net.cn



















<appender name="AMQP" ...>
    ...
    <clientConnectionProperties>thing1:thing2,cat:hat</clientConnectionProperties>
    ...
</appender>














<Appenders>
    ...
    <RabbitMQ name="rabbitmq"
        ...
        clientConnectionProperties="thing1:thing2,cat:hat"
        ...
    </RabbitMQ>
</Appenders>














这些属性是逗号分隔的列表key:value对。
键和值不能包含逗号或冒号。spring-doc.cadn.net.cn






查看连接时，这些属性将显示在 RabbitMQ 管理 UI 上。spring-doc.cadn.net.cn








高级回登录技术




您可以对 Logback 附加程序进行子类化。
这样做可以在建立连接之前修改客户端连接属性。
以下示例显示了如何执行此作：spring-doc.cadn.net.cn








public class MyEnhancedAppender extends AmqpAppender {

    private String thing1;

    @Override
    protected void updateConnectionClientProperties(Map<String, Object> clientProperties) {
        clientProperties.put("thing1", this.thing1);
    }

    public void setThing1(String thing1) {
        this.thing1 = thing1;
    }

}








然后你可以添加<thing1>thing2</thing1>logback.xml。spring-doc.cadn.net.cn






对于 String 属性（如前面示例中所示的属性），可以使用前面的技术。
子类允许添加更丰富的属性（例如添加Map或数字属性）。spring-doc.cadn.net.cn












提供自定义队列实现






这AmqpAppenders使用BlockingQueue以异步将日志事件发布到 RabbitMQ。
默认情况下，一个LinkedBlockingQueue被使用。
但是，您可以提供任何类型的定制BlockingQueue实现。spring-doc.cadn.net.cn






以下示例显示了如何为 Logback 执行此作：spring-doc.cadn.net.cn








public class MyEnhancedAppender extends AmqpAppender {

    @Override
    protected BlockingQueue<Event> createEventQueue() {
        return new ArrayBlockingQueue();
    }

}








Log4j 2 附加器支持使用BlockingQueueFactory，如以下示例所示：spring-doc.cadn.net.cn








<Appenders>
    ...
    <RabbitMQ name="rabbitmq"
              bufferSize="10" ... >
        <ArrayBlockingQueue/>
    </RabbitMQ>
</Appenders>