mirror of
https://github.com/PaperMC/Paper.git
synced 2024-11-26 12:36:07 +01:00
Handle plugin prefixes in Log4j configuration
This commit is contained in:
parent
10893fea38
commit
bbfc0c8ee3
@ -0,0 +1,44 @@
|
|||||||
|
From 862e7c3bc002483f3d98c7f24ea0e06d6575a3eb Mon Sep 17 00:00:00 2001
|
||||||
|
From: Minecrell <dev@minecrell.net>
|
||||||
|
Date: Thu, 21 Sep 2017 16:14:13 +0200
|
||||||
|
Subject: [PATCH] Handle plugin prefixes in implementation logging
|
||||||
|
configuration
|
||||||
|
|
||||||
|
Currently, plugin prefixes are prepended to the log message in
|
||||||
|
the PluginLogger before passing the message to the underlying
|
||||||
|
logging framework. This is bad design because they need to be
|
||||||
|
stripped manually when using custom appenders to log messages
|
||||||
|
in a different format.
|
||||||
|
|
||||||
|
Additionally, it makes integration of alternative logging APIs hard
|
||||||
|
because all logging must go through the PluginLogger. Avoid using
|
||||||
|
PluginLogger and create a regular logger using the plugin name.
|
||||||
|
The implementation should handle plugin prefixes by displaying
|
||||||
|
logger names when appropriate.
|
||||||
|
|
||||||
|
diff --git a/src/main/java/org/bukkit/plugin/java/JavaPlugin.java b/src/main/java/org/bukkit/plugin/java/JavaPlugin.java
|
||||||
|
index 16b1eb37..0abad9ad 100644
|
||||||
|
--- a/src/main/java/org/bukkit/plugin/java/JavaPlugin.java
|
||||||
|
+++ b/src/main/java/org/bukkit/plugin/java/JavaPlugin.java
|
||||||
|
@@ -50,7 +50,7 @@ public abstract class JavaPlugin extends PluginBase {
|
||||||
|
private boolean naggable = true;
|
||||||
|
private FileConfiguration newConfig = null;
|
||||||
|
private File configFile = null;
|
||||||
|
- private PluginLogger logger = null;
|
||||||
|
+ private Logger logger = null; // Paper - PluginLogger -> Logger
|
||||||
|
|
||||||
|
public JavaPlugin() {
|
||||||
|
final ClassLoader classLoader = this.getClass().getClassLoader();
|
||||||
|
@@ -277,7 +277,8 @@ public abstract class JavaPlugin extends PluginBase {
|
||||||
|
this.dataFolder = dataFolder;
|
||||||
|
this.classLoader = classLoader;
|
||||||
|
this.configFile = new File(dataFolder, "config.yml");
|
||||||
|
- this.logger = new PluginLogger(this);
|
||||||
|
+ // Paper - Handle plugin prefix in implementation
|
||||||
|
+ this.logger = Logger.getLogger(description.getPrefix() != null ? description.getPrefix() : description.getName());
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
--
|
||||||
|
2.14.1
|
||||||
|
|
@ -0,0 +1,74 @@
|
|||||||
|
From c5fa4d29b7cf19517b522dc34ce0d3c3aec40b04 Mon Sep 17 00:00:00 2001
|
||||||
|
From: Minecrell <dev@minecrell.net>
|
||||||
|
Date: Thu, 21 Sep 2017 16:14:55 +0200
|
||||||
|
Subject: [PATCH] Handle plugin prefixes using Log4J configuration
|
||||||
|
|
||||||
|
Display logger name in the console for all loggers except the
|
||||||
|
root logger, Bukkit's logger ("Minecraft") and Minecraft loggers.
|
||||||
|
Since plugins now use the plugin name as logger name this will
|
||||||
|
restore the plugin prefixes without having to prepend them manually
|
||||||
|
to the log messages.
|
||||||
|
|
||||||
|
Logger prefixes are shown by default for all loggers except for
|
||||||
|
the root logger, the Minecraft/Mojang loggers and the Bukkit loggers.
|
||||||
|
This may cause additional prefixes to be disabled for plugins bypassing
|
||||||
|
the plugin logger.
|
||||||
|
|
||||||
|
diff --git a/pom.xml b/pom.xml
|
||||||
|
index aff997468..dfb006aa0 100644
|
||||||
|
--- a/pom.xml
|
||||||
|
+++ b/pom.xml
|
||||||
|
@@ -94,7 +94,7 @@
|
||||||
|
<groupId>org.apache.logging.log4j</groupId>
|
||||||
|
<artifactId>log4j-core</artifactId>
|
||||||
|
<version>2.8.1</version>
|
||||||
|
- <scope>runtime</scope>
|
||||||
|
+ <scope>compile</scope>
|
||||||
|
</dependency>
|
||||||
|
|
||||||
|
<!-- Paper - Add additional Log4J dependencies -->
|
||||||
|
diff --git a/src/main/java/org/spigotmc/SpigotConfig.java b/src/main/java/org/spigotmc/SpigotConfig.java
|
||||||
|
index 712fc1f9b..b5bfb15fa 100644
|
||||||
|
--- a/src/main/java/org/spigotmc/SpigotConfig.java
|
||||||
|
+++ b/src/main/java/org/spigotmc/SpigotConfig.java
|
||||||
|
@@ -282,7 +282,7 @@ public class SpigotConfig
|
||||||
|
private static void playerSample()
|
||||||
|
{
|
||||||
|
playerSample = getInt( "settings.sample-count", 12 );
|
||||||
|
- System.out.println( "Server Ping Player Sample Count: " + playerSample );
|
||||||
|
+ Bukkit.getLogger().log( Level.INFO, "Server Ping Player Sample Count: {0}", playerSample ); // Paper - Use logger
|
||||||
|
}
|
||||||
|
|
||||||
|
public static int playerShuffle;
|
||||||
|
diff --git a/src/main/resources/log4j2.xml b/src/main/resources/log4j2.xml
|
||||||
|
index 08b6bb7f9..9f8334376 100644
|
||||||
|
--- a/src/main/resources/log4j2.xml
|
||||||
|
+++ b/src/main/resources/log4j2.xml
|
||||||
|
@@ -2,10 +2,22 @@
|
||||||
|
<Configuration status="WARN">
|
||||||
|
<Appenders>
|
||||||
|
<TerminalConsole name="TerminalConsole">
|
||||||
|
- <PatternLayout pattern="%highlightError{[%d{HH:mm:ss} %level]: %minecraftFormatting{%msg}%n%xEx}" />
|
||||||
|
+ <PatternLayout>
|
||||||
|
+ <LoggerNamePatternSelector defaultPattern="%highlightError{[%d{HH:mm:ss} %level]: [%logger] %minecraftFormatting{%msg}%n%xEx}">
|
||||||
|
+ <!-- Log root, Minecraft, Mojang and Bukkit loggers without prefix -->
|
||||||
|
+ <PatternMatch key=",net.minecraft.,Minecraft,com.mojang."
|
||||||
|
+ pattern="%highlightError{[%d{HH:mm:ss} %level]: %minecraftFormatting{%msg}%n%xEx}" />
|
||||||
|
+ </LoggerNamePatternSelector>
|
||||||
|
+ </PatternLayout>
|
||||||
|
</TerminalConsole>
|
||||||
|
<RollingRandomAccessFile name="File" fileName="logs/latest.log" filePattern="logs/%d{yyyy-MM-dd}-%i.log.gz">
|
||||||
|
- <PatternLayout pattern="[%d{HH:mm:ss}] [%t/%level]: %minecraftFormatting{%msg}{strip}%n" />
|
||||||
|
+ <PatternLayout>
|
||||||
|
+ <LoggerNamePatternSelector defaultPattern="[%d{HH:mm:ss}] [%t/%level]: [%logger] %minecraftFormatting{%msg}{strip}%n">
|
||||||
|
+ <!-- Log root, Minecraft, Mojang and Bukkit loggers without prefix -->
|
||||||
|
+ <PatternMatch key=",net.minecraft.,Minecraft,com.mojang."
|
||||||
|
+ pattern="[%d{HH:mm:ss}] [%t/%level]: %minecraftFormatting{%msg}{strip}%n" />
|
||||||
|
+ </LoggerNamePatternSelector>
|
||||||
|
+ </PatternLayout>
|
||||||
|
<Policies>
|
||||||
|
<TimeBasedTriggeringPolicy />
|
||||||
|
<OnStartupTriggeringPolicy />
|
||||||
|
--
|
||||||
|
2.14.1
|
||||||
|
|
Loading…
Reference in New Issue
Block a user