CentralLoggerClientStandalone.java
/*
** Module : CentralLoggerClientStandalone.java
** Abstract : CentralLogger for clients that log by themselves.
**
** Copyright (c) 2023-2024, Golden Code Development Corporation.
**
** -#- -I- --Date-- ----------------------------Description-----------------------------
** 001 GBB 20230424 Initial setup
** 002 GBB 20230517 Passing in appserver name to the log file name resolvement method.
** 003 GBB 20230519 Support for %as placeholder in log file names with serverSide.
** Support for disabling rotation.
** 004 GBB 20230530 Use default log file name on issues with provided path.
** 005 RAA 20230608 Added null parameter to resolveLogFile.
** 006 GBB 20230619 Adding field level to each logger instance to boost isLoggable performance.
** 007 GBB 20230626 Sends to the server the client log file name.
** 008 GBB 20240729 Support for writing to slf4j api.
*/
/*
** This program is free software: you can redistribute it and/or modify
** it under the terms of the GNU Affero General Public License as
** published by the Free Software Foundation, either version 3 of the
** License, or (at your option) any later version.
**
** This program is distributed in the hope that it will be useful,
** but WITHOUT ANY WARRANTY; without even the implied warranty of
** MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
** GNU Affero General Public License for more details.
**
** You may find a copy of the GNU Affero GPL version 3 at the following
** location: https://www.gnu.org/licenses/agpl-3.0.en.html
**
** Additional terms under GNU Affero GPL version 3 section 7:
**
** Under Section 7 of the GNU Affero GPL version 3, the following additional
** terms apply to the works covered under the License. These additional terms
** are non-permissive additional terms allowed under Section 7 of the GNU
** Affero GPL version 3 and may not be removed by you.
**
** 0. Attribution Requirement.
**
** You must preserve all legal notices or author attributions in the covered
** work or Appropriate Legal Notices displayed by works containing the covered
** work. You may not remove from the covered work any author or developer
** credit already included within the covered work.
**
** 1. No License To Use Trademarks.
**
** This license does not grant any license or rights to use the trademarks
** Golden Code, FWD, any Golden Code or FWD logo, or any other trademarks
** of Golden Code Development Corporation. You are not authorized to use the
** name Golden Code, FWD, or the names of any author or contributor, for
** publicity purposes without written authorization.
**
** 2. No Misrepresentation of Affiliation.
**
** You may not represent yourself as Golden Code Development Corporation or FWD.
**
** You may not represent yourself for publicity purposes as associated with
** Golden Code Development Corporation, FWD, or any author or contributor to
** the covered work, without written authorization.
**
** 3. No Misrepresentation of Source or Origin.
**
** You may not represent the covered work as solely your work. All modified
** versions of the covered work must be marked in a reasonable way to make it
** clear that the modified work is not originating from Golden Code Development
** Corporation or FWD. All modified versions must contain the notices of
** attribution required in this license.
*/
package com.goldencode.p2j.util.logging;
import com.goldencode.p2j.main.*;
import java.io.*;
import java.util.logging.*;
import static com.goldencode.p2j.util.logging.LoggingUtil.*;
/**
* A concrete version of CentralLogger for apps launched by
* {@link com.goldencode.p2j.main.ClientDriver#main} and writing their own log files.
*/
public class CentralLoggerClientStandalone
extends CentralLogger
{
/** The one and only log handler, responsible for writing all logs to files. */
private static volatile FileHandler fileHandler;
/**
* Package-private constructor for CentralLoggerClientStandalone.
*
* @param loggerName
* The name of the logger.
* @param level
* The level of the logger.
* @param checkParentLevels
* Flag to prevent recursion for class loaders.
* @param excludeSMContext
* Flag to prevent deadlock on SecurityManager.
*/
CentralLoggerClientStandalone(String loggerName, Level level, boolean checkParentLevels, boolean excludeSMContext)
{
super(loggerName, level, checkParentLevels, excludeSMContext);
}
/** Method called when CentralLogger configuration has been completed.
*
* @param filePath
* The file path from server's directory.
* @param rotationLimit
* The file number limit from server's directory.
* @param rotationCount
* The file size limit from server's directory.
* @param appServerName
* The appServer name.
*/
static void setupFileHandler(String filePath, int rotationLimit, int rotationCount, String appServerName)
{
long processId = ClientCore.isNativeLayerInitialized() ? ClientCore.getPid() : 0;
String userOS = ClientCore.isNativeLayerInitialized() ? ClientCore.getUserName() : "";
String userFwd = CentralLoggerClient.getUserId();
boolean isRotationDisabled = rotationLimit == 0 || rotationCount == 0;
filePath = LoggingUtil.resolveLogFile(filePath,
() -> processId,
userOS,
userFwd,
appServerName,
"client",
null,
isRotationDisabled);
CentralLogger centralLogger = CentralLogger.get(CentralLoggerClientStandalone.class);
String msg = "Configs received: WRITE_TO_SLF4J_API %b, file path %s, rotationLimit %d, rotationCount %d.";
centralLogger.log(Level.INFO,
msg,
WRITE_TO_SLF4J_API,
filePath,
rotationLimit,
rotationCount);
if (!WRITE_TO_SLF4J_API && !canWriteToPath(filePath))
{
filePath = LoggingUtil.resolveLogFile(DEFAULT_CLIENT_LOG_FILE_NAME,
() -> processId,
userOS,
userFwd,
appServerName,
"client",
null,
isRotationDisabled);
centralLogger.info("Initializing logging with default file path " + filePath);
}
try
{
fileHandler = setFileHandler(isRotationDisabled,
filePath,
rotationLimit,
rotationCount,
new CentralLogFormatter());
if (fileHandler != null)
{
String logfileAbsolutePath = new File(filePath.replace("%g", "0")).getAbsolutePath();
CentralLoggerClient.getLogService().setFwdLogfile(logfileAbsolutePath);
}
}
catch (IOException io)
{
centralLogger.severe("FileHandler couldn't be initialized:", io);
}
}
/** On JVM shutdown closes log files. */
static void closeFiles()
{
if (fileHandler != null)
{
fileHandler.close();
}
}
/**
* Publishes a log record. Before initialization the log record is added to the pre-init buffer. After
* initialization the log record is published to the file handler.
*
* @param logRecord
* The log record.
*/
@Override
protected void publish(ContextLogRecord logRecord)
{
if (getRootLevel() == null)
{
addToPreInitBuffer(logRecord);
return;
}
if (WRITE_TO_SLF4J_API)
{
logToSlf4j(logRecord, false, false);
}
else if (fileHandler != null)
{
fileHandler.publish(logRecord);
fileHandler.flush();
}
}
}