Skip to content

Create DefaultLayout independent of PatternLayout #3118

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Oct 25, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,6 @@
import java.io.File;
import java.io.IOException;
import java.io.InputStream;
import java.io.Serializable;
import java.lang.ref.WeakReference;
import java.net.URI;
import java.util.ArrayList;
Expand All @@ -40,7 +39,6 @@
import org.apache.logging.log4j.Level;
import org.apache.logging.log4j.core.Appender;
import org.apache.logging.log4j.core.Filter;
import org.apache.logging.log4j.core.Layout;
import org.apache.logging.log4j.core.LifeCycle2;
import org.apache.logging.log4j.core.LogEvent;
import org.apache.logging.log4j.core.LoggerContext;
Expand All @@ -58,7 +56,6 @@
import org.apache.logging.log4j.core.config.plugins.util.PluginManager;
import org.apache.logging.log4j.core.config.plugins.util.PluginType;
import org.apache.logging.log4j.core.filter.AbstractFilterable;
import org.apache.logging.log4j.core.layout.PatternLayout;
import org.apache.logging.log4j.core.lookup.ConfigurationStrSubstitutor;
import org.apache.logging.log4j.core.lookup.Interpolator;
import org.apache.logging.log4j.core.lookup.PropertiesLookup;
Expand Down Expand Up @@ -779,11 +776,7 @@ public static Level getDefaultLevel() {
protected void setToDefault() {
// LOG4J2-1176 facilitate memory leak investigation
setName(DefaultConfiguration.DEFAULT_NAME + "@" + Integer.toHexString(hashCode()));
final Layout<? extends Serializable> layout = PatternLayout.newBuilder()
.withPattern(DefaultConfiguration.DEFAULT_PATTERN)
.withConfiguration(this)
.build();
final Appender appender = ConsoleAppender.createDefaultAppenderForLayout(layout);
final Appender appender = ConsoleAppender.createDefaultAppenderForLayout(DefaultLayout.INSTANCE);
appender.start();
addAppender(appender);
final LoggerConfig rootLoggerConfig = getRootLogger();
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,88 @@
/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to you 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
*
* http://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.apache.logging.log4j.core.config;

import java.nio.charset.Charset;
import java.util.Collections;
import java.util.Map;
import org.apache.logging.log4j.core.LogEvent;
import org.apache.logging.log4j.core.StringLayout;
import org.apache.logging.log4j.core.layout.ByteBufferDestination;
import org.apache.logging.log4j.status.StatusData;

/**
* A simple layout used only by {@link DefaultConfiguration}
* <p>
* This layout allows to create applications that don't contain {@link org.apache.logging.log4j.core.layout.PatternLayout}
* and all its patterns, e.g. GraalVM applications.
* </p>
*
* @since 2.25.0
*/
final class DefaultLayout implements StringLayout {

static final StringLayout INSTANCE = new DefaultLayout();

private DefaultLayout() {}

@Override
public String toSerializable(LogEvent event) {
return new StatusData(
event.getSource(),
event.getLevel(),
event.getMessage(),
event.getThrown(),
event.getThreadName())
.getFormattedStatus();
}

@Override
public byte[] toByteArray(LogEvent event) {
return toSerializable(event).getBytes(Charset.defaultCharset());
}

@Override
public void encode(LogEvent event, ByteBufferDestination destination) {
final byte[] data = toByteArray(event);
destination.writeBytes(data, 0, data.length);
}

@Override
public String getContentType() {
return "text/plain";
}

@Override
public Charset getCharset() {
return Charset.defaultCharset();
}

@Override
public byte[] getFooter() {
return null;
}

@Override
public byte[] getHeader() {
return null;
}

@Override
public Map<String, String> getContentFormat() {
return Collections.emptyMap();
}
}
11 changes: 11 additions & 0 deletions src/changelog/.2.x.x/3118_default_layout.xml
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
<?xml version="1.0" encoding="UTF-8"?>
<entry xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns="https://logging.apache.org/xml/ns"
xsi:schemaLocation="https://logging.apache.org/xml/ns https://logging.apache.org/xml/ns/log4j-changelog-0.xsd"
type="changed">
<issue id="3118" link="https://github.com/apache/logging-log4j2/pull/3118"/>
<description format="asciidoc">
Changes the layout used by the
https://logging.apache.org/log4j/2.x/manual/configuration.html#automatic-configuration[default configuration].
</description>
</entry>