Package io.github.connellite.logger
Class FileLoggers
java.lang.Object
io.github.connellite.logger.FileLoggers
Attaches a
FileLogHandler to Logger instances.
Example (one file per class), logger name is a short string (for example the file name):
import java.lang.invoke.MethodHandles;
private static final Logger LOGGER = FileLoggers.forLogFile(
MethodHandles.lookup().lookupClass().getSimpleName() + ".log",
Path.of("logs", "modules", MethodHandles.lookup().lookupClass().getSimpleName() + ".log"));
static {
LOGGER.setLevel(Level.FINE);
}
Shorter overload: forLogFile(Path) uses Path.getFileName() as the logger name.
Async counterparts are forAsyncLogFile(String, Path, AsyncFileLogHandlerConfig) and
addAsyncFileHandler(Logger, Path, AsyncFileLogHandlerConfig).
Buffered counterparts forBufferedLogFile(String, Path, FileLogHandlerConfig) and
addBufferedFileHandler(Logger, Path, FileLogHandlerConfig) keep records in a buffer and open the file
only to drain it. They are deprecated and not recommended for production.
Each record is one line from the handler's Formatter
(SimpleFormatter by default; override via FileLogHandlerConfig.withFormatter(java.util.logging.Formatter)).
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionstatic AsyncFileLogHandleraddAsyncFileHandler(Logger logger, Path logFile) static AsyncFileLogHandleraddAsyncFileHandler(Logger logger, Path logFile, AsyncFileLogHandlerConfig config) static BufferedFileLogHandleraddBufferedFileHandler(Logger logger, Path logFile) Deprecated.Not recommended for production.static BufferedFileLogHandleraddBufferedFileHandler(Logger logger, Path logFile, FileLogHandlerConfig config) Deprecated.Not recommended for production.static FileLogHandleraddFileHandler(Logger logger, Path logFile) static FileLogHandleraddFileHandler(Logger logger, Path logFile, FileLogHandlerConfig config) static LoggerforAsyncLogFile(String loggerName, Path logFile) static LoggerforAsyncLogFile(String loggerName, Path logFile, AsyncFileLogHandlerConfig config) static LoggerforAsyncLogFile(Path logFile) UseslogFile.getFileName().toString()as the logger name (two different paths with the same file name share oneLogger— pass an explicit name if that is a problem).static LoggerforAsyncLogFile(Path logFile, AsyncFileLogHandlerConfig config) static LoggerforBufferedLogFile(String loggerName, Path logFile) Deprecated.Not recommended for production.static LoggerforBufferedLogFile(String loggerName, Path logFile, FileLogHandlerConfig config) Deprecated.Not recommended for production.static LoggerforBufferedLogFile(Path logFile) Deprecated.Not recommended for production.static LoggerforBufferedLogFile(Path logFile, FileLogHandlerConfig config) Deprecated.Not recommended for production.static LoggerforLogFile(String loggerName, Path logFile) static LoggerforLogFile(String loggerName, Path logFile, FileLogHandlerConfig config) static LoggerforLogFile(Path logFile) UseslogFile.getFileName().toString()as the logger name (two different paths with the same file name share oneLogger— pass an explicit name if that is a problem).static LoggerforLogFile(Path logFile, FileLogHandlerConfig config)
-
Constructor Details
-
FileLoggers
public FileLoggers()
-
-
Method Details
-
forLogFile
-
forLogFile
-
forLogFile
UseslogFile.getFileName().toString()as the logger name (two different paths with the same file name share oneLogger— pass an explicit name if that is a problem). -
forLogFile
-
addFileHandler
public static FileLogHandler addFileHandler(Logger logger, Path logFile, FileLogHandlerConfig config) -
addFileHandler
-
forBufferedLogFile
@Deprecated public static Logger forBufferedLogFile(String loggerName, Path logFile, FileLogHandlerConfig config) Deprecated.Not recommended for production. The file is opened only to drain the buffer. PreferforLogFile(String, Path, FileLogHandlerConfig). -
forBufferedLogFile
Deprecated.Not recommended for production. PreferforLogFile(String, Path). -
forBufferedLogFile
Deprecated.Not recommended for production. PreferforLogFile(Path).UseslogFile.getFileName().toString()as the logger name (two different paths with the same file name share oneLogger— pass an explicit name if that is a problem). -
forBufferedLogFile
Deprecated.Not recommended for production. PreferforLogFile(Path, FileLogHandlerConfig). -
addBufferedFileHandler
@Deprecated public static BufferedFileLogHandler addBufferedFileHandler(Logger logger, Path logFile, FileLogHandlerConfig config) Deprecated.Not recommended for production. The file is opened only to drain the buffer. PreferaddFileHandler(Logger, Path, FileLogHandlerConfig). -
addBufferedFileHandler
@Deprecated public static BufferedFileLogHandler addBufferedFileHandler(Logger logger, Path logFile) Deprecated.Not recommended for production. PreferaddFileHandler(Logger, Path). -
forAsyncLogFile
public static Logger forAsyncLogFile(String loggerName, Path logFile, AsyncFileLogHandlerConfig config) -
forAsyncLogFile
-
forAsyncLogFile
UseslogFile.getFileName().toString()as the logger name (two different paths with the same file name share oneLogger— pass an explicit name if that is a problem). -
forAsyncLogFile
-
addAsyncFileHandler
public static AsyncFileLogHandler addAsyncFileHandler(Logger logger, Path logFile, AsyncFileLogHandlerConfig config) -
addAsyncFileHandler
-