[logback-dev] [JIRA] (LOGBACK-950) conversionRule to have ability to customize MessageFormatter

Fri, 21 Feb 2014 22:04:26 -0800

Issue Type: Improvement Improvement
Assignee: Logback dev list
Attachments: test-converter.zip
Components: logback-classic
Created: 22/Feb/14 7:01 AM
Description:

The target was to use function other then toString() on object that are passed to MessageFormatter.

Reason is the toString() will be used by business presentation and debug presentation will be different.

Attempt had been made to customize org.slf4j.helpers.MessageFormatter just using logback API and configuration files.

Example implementation attached.

Short code summary:

 

    <conversionRule conversionWord="message" converterClass="org.sample.DebugViewMessageConverter" />

    <appender name="ConsoleAppender1" class="ch.qos.logback.core.ConsoleAppender">
        <encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
            <pattern>[2]%-5level %message\n</pattern>
        </encoder>
    </appender>


public interface IDebugView {

    public String getDebugView();

}

public class DebugViewMessageConverter extends ClassicConverter {

    @Override
    public String convert(ILoggingEvent event) {
        Object[] argumentArray = event.getArgumentArray();
        if (argumentArray != null) {
            boolean hasDebugView = false;
            for (int i = 0; i < argumentArray.length; i++) {
                if (argumentArray[i] instanceof IDebugView) {
                    argumentArray[i] = ((IDebugView) argumentArray[i]).getDebugView();
                    hasDebugView = true;
                }
            }
            if (hasDebugView) {
                // Need to store it in Event so multiple loggers will use this message, otherwise  toString() of the objects will be used in message.
                LoggingEventAccess.setFormattedMessage((LoggingEvent) event, MessageFormatter.arrayFormat(event.getMessage(), argumentArray).getMessage());
            }
        }
        return event.getFormattedMessage();
    }
}

 
public class DebugObject implements IDebugView {

    private final String text;

    public DebugObject(String text) {
        this.text = text;
    }

    public String getDebugView() {
        return text;
    }

    @Override
    public String toString() {
        return "!!not this!!";
    }

}
log.info("test message: {}", new DebugObject("print this"));

result:
INFO  test message: print this
Project: logback
Priority: Minor Minor
Reporter: Vlad Skarzhevskyy
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators
For more information on JIRA, see: http://www.atlassian.com/software/jira 
_______________________________________________
logback-dev mailing list
[email protected]
http://mailman.qos.ch/mailman/listinfo/logback-dev

Reply via email to