org.springframework.kafka.support.LoggingProducerListener Maven / Gradle / Ivy
/*
* Copyright 2015-2020 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.springframework.kafka.support;
import org.apache.commons.logging.LogFactory;
import org.apache.kafka.clients.producer.ProducerRecord;
import org.springframework.core.log.LogAccessor;
import org.springframework.util.ObjectUtils;
/**
* The {@link ProducerListener} that logs exceptions thrown when sending messages.
*
* @param the key type.
* @param the value type.
*
* @author Marius Bogoevici
* @author Gary Russell
*/
public class LoggingProducerListener implements ProducerListener {
/**
* Default max content logged.
*/
public static final int DEFAULT_MAX_CONTENT_LOGGED = 100;
private static final LogAccessor LOGGER = new LogAccessor(LogFactory.getLog(LoggingProducerListener.class));
private boolean includeContents = true;
private int maxContentLogged = DEFAULT_MAX_CONTENT_LOGGED;
/**
* Whether the log message should include the contents (key and payload).
*
* @param includeContents true if the contents of the message should be logged
*/
public void setIncludeContents(boolean includeContents) {
this.includeContents = includeContents;
}
/**
* The maximum amount of data to be logged for either key or password. As message sizes may vary and
* become fairly large, this allows limiting the amount of data sent to logs.
* Default {@value #DEFAULT_MAX_CONTENT_LOGGED}.
*
* @param maxContentLogged the maximum amount of data being logged.
*/
public void setMaxContentLogged(int maxContentLogged) {
this.maxContentLogged = maxContentLogged;
}
@Override
public void onError(ProducerRecord record, Exception exception) {
LOGGER.error(exception, () -> {
StringBuffer logOutput = new StringBuffer();
logOutput.append("Exception thrown when sending a message");
if (this.includeContents) {
logOutput.append(" with key='")
.append(toDisplayString(ObjectUtils.nullSafeToString(record.key()), this.maxContentLogged))
.append("'")
.append(" and payload='")
.append(toDisplayString(ObjectUtils.nullSafeToString(record.value()), this.maxContentLogged))
.append("'");
}
logOutput.append(" to topic ").append(record.topic());
if (record.partition() != null) {
logOutput.append(" and partition ").append(record.partition());
}
logOutput.append(":");
return logOutput.toString();
});
}
private String toDisplayString(String original, int maxCharacters) {
if (original.length() <= maxCharacters) {
return original;
}
return original.substring(0, maxCharacters) + "...";
}
}