com.goldencode.p2j.util.logging

Class CentralLoggerClient

java.lang.Object

com.goldencode.p2j.util.logging.CentralLogger

com.goldencode.p2j.util.logging.CentralLoggerClient

public class CentralLoggerClient
extends CentralLogger

A concrete version of CentralLogger for apps launched by ClientDriver.main(java.lang.String[]) and sending logs to the server.

Nested Class Summary

Nested classes/interfaces inherited from class com.goldencode.p2j.util.logging.CentralLogger

CentralLogger.MdcVar, CentralLogger.Mode, CentralLogger.Slf4jKey

Field Summary

Fields

Modifier and Type	Field and Description
private static long	clientPid This client process ID.
private static java.lang.String	clientUserOs This client process OS user ID.
private static java.util.Queue<CentralLogRecord>	LOG_BUFFER Thread-safe queue to store logs before being sent to the server on state sync or logger finish.
private static CentralLogService	logService The remote log service on the server to receive the leftover log messages on finish().
private static java.lang.Integer	sessionId The server session ID.
private static java.lang.String	userId The server user ID.

Fields inherited from class com.goldencode.p2j.util.logging.CentralLogger

DEFAULT_CLIENT_LOG_FILE_NAME, DEFAULT_FILE_COUNT, DEFAULT_FILE_LIMIT_BYTES, DEFAULT_ROOT_LEVEL, DEFAULT_SERVER_LOG_FILE_NAME, IS_LOGGER_WORK_FINISHED, JVM_ARG_ENABLE_SLF4j_API, MIN_FILE_COUNT, MIN_FILE_LIMIT_BYTES, WRITE_TO_SLF4J_API

Constructor Summary

Constructors

Constructor and Description
CentralLoggerClient(java.lang.String loggerName, java.util.logging.Level level, boolean checkParentLevels, boolean excludeSMContext) Package-private constructor for CentralLoggerClient.

Method Summary

Modifier and Type	Method and Description
static void	finish() Allows graceful completion of logger work.
(package private) static java.util.List<java.util.logging.LogRecord>	getLeftoverLogs() Returns a List of all logs present in the buffer converted to CentralLogRecord.
static CentralLogService	getLogService() Returns the server log service.
static java.lang.Integer	getSessionId() Returns the remote server session ID.
static java.lang.String	getUserId() Returns the remote server user ID.
protected void	publish(ContextLogRecord logRecord) Publishes a log record.
static CentralLogRecord[]	pullLogs() Copies all logs currently in the buffer to an array and returns it.
private static void	pushLogs(CentralLogRecord[] logRecords) Adds log records to the buffer.
static void	setLogService(CentralLogService logService) Static setter for logService.
static void	setPid(long clientPid) Sets this client process ID.
static void	setupFileHandler(java.lang.String filePath, int fileLimit, int fileCount, java.lang.String appServerName) Creates and configures a file handler for the specified client process.
static void	setUserOs(java.lang.String clientUserOs) Sets this client process OS user ID.

Methods inherited from class com.goldencode.p2j.util.logging.CentralLogger

addToPreInitBuffer, all, completePreInitWork, config, equals, findLevel, fine, fine, finer, finest, generate, get, get, get, getExplicitLevel, getLevel, getLoggerLevelMap, getLoggerName, getMode, getRootLevel, getSlf4jLogBuilder, handleShutDown, hashCode, info, info, initializeClient, isCheckParentLevels, isClient, isExcludeSMContext, isLoggable, log, log, log, log, log, logp, logp, logStream, logToSlf4j, setBootstrapConfig, setFileHandler, setLevel, setLevels, setMode, severe, severe, warning, warning, warning

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Field Detail

LOG_BUFFER

private static final java.util.Queue<CentralLogRecord> LOG_BUFFER

Thread-safe queue to store logs before being sent to the server on state sync or logger finish.

logService

private static volatile CentralLogService logService

The remote log service on the server to receive the leftover log messages on finish(). Not used for other logs, otherwise causes infinite recursion.

clientPid

private static volatile long clientPid

This client process ID.

clientUserOs

private static volatile java.lang.String clientUserOs

This client process OS user ID.

sessionId

private static volatile java.lang.Integer sessionId

The server session ID.

userId

private static volatile java.lang.String userId

The server user ID.

Constructor Detail

CentralLoggerClient

CentralLoggerClient(java.lang.String loggerName,
                    java.util.logging.Level level,
                    boolean checkParentLevels,
                    boolean excludeSMContext)

Package-private constructor for CentralLoggerClient.

Parameters:

loggerName - The name of the logger.

level - The level of the logger.

checkParentLevels - Flag to prevent recursion for class loaders.

excludeSMContext - Flag to prevent deadlock on SecurityManager.

Method Detail

setLogService

public static void setLogService(CentralLogService logService)

Static setter for logService.

Parameters:

logService - The log service.

getLogService

public static CentralLogService getLogService()

Returns the server log service.

Returns:

The server log service.

setPid

public static void setPid(long clientPid)

Sets this client process ID.

Parameters:

clientPid - This client process ID.

setUserOs

public static void setUserOs(java.lang.String clientUserOs)

Sets this client process OS user ID.

Parameters:

clientUserOs - This client process OS user ID.

getSessionId

public static java.lang.Integer getSessionId()

Returns the remote server session ID.

Returns:

The remote server session ID.

getUserId

public static java.lang.String getUserId()

Returns the remote server user ID.

Returns:

The remote server user ID.

finish

public static void finish()

Allows graceful completion of logger work. Called right before server session is terminated or on exception in client execution. If logService has not been set, it leaves it to CentralLogger.handleShutDown(), which is usually called later. Otherwise, the leftover logs, still not synced to the server, are pushed over rpc and a flag is raised to disable further logging, thus avoiding recursion.

pullLogs

public static CentralLogRecord[] pullLogs()

Copies all logs currently in the buffer to an array and returns it.

Returns:

CentralLogRecord array with all logs still not sent to the server.

getLeftoverLogs

static java.util.List<java.util.logging.LogRecord> getLeftoverLogs()

Returns a List of all logs present in the buffer converted to CentralLogRecord.

Returns:

A List of all logs present in the log buffer.

pushLogs

private static void pushLogs(CentralLogRecord[] logRecords)

Adds log records to the buffer.

Parameters:

logRecords - An array of log records.

setupFileHandler

public static void setupFileHandler(java.lang.String filePath,
                                    int fileLimit,
                                    int fileCount,
                                    java.lang.String appServerName)

Creates and configures a file handler for the specified client process.

Parameters:

filePath - The path to the log file.

fileLimit - The file limit, or the max bytes in a log file before rotation.

fileCount - The file count, or the max number of files before file overwrite starts.

appServerName - The appServer name.

publish

protected void publish(ContextLogRecord logRecord)

Publishes a log record. Before initialization the log record is added to the pre-init buffer. After initialization the log record is added to the regular buffer.

Specified by:

publish in class CentralLogger

Parameters:

logRecord - A log record.