uws.service.log

Class Slf4jUWSLog

java.lang.Object

uws.service.log.Slf4jUWSLog

All Implemented Interfaces:

UWSLog

Direct Known Subclasses:

Slf4jTAPLog

public class Slf4jUWSLog
extends java.lang.Object
implements UWSLog

This implementation of UWSLog forwards all log submission to SLF4J.

Thus, a UWS implementor can choose how to deal with logs. SLF4J already provides bridges at least for the following logging frameworks:

• NOPE (all logs are merely discarded),
• simple logging mechanism (console, file, ...),
• JUL (java.util.logging),
• Log4J,
• JCL (Jakarta Commons Logging),
• and LogBack.

SLF4J loggers

A different logger is used in function of the log entry's CONTEXT. Four values are supported: "UWS", "HTTP", "JOB" and "THREAD". If a different value is set for the CONTEXT, the general/root logger will be used.

The ID of each logger follows this rule:

"uws.service"{SUFFIX}

The ID of the general/root logger is just "uws.service". For all the other specific loggers, {SUFFIX} is a dot followed by one among "UWS", "HTTP", "JOB" and "THREAD". Thus, the full ID of the logger for the HTTP requests is:

uws.service.http

Log entries format

All log entries are formatted as follow:

{EVENT} - {ID} - {MESSAGE} - {ADDITIONAL_DATA}

{EVENT}, {ID} and {ADDITIONAL_DATA} may not be all provided for some messages ; all are optional, and especially ADDITIONAL_DATA. When not provided, each is replaced by an empty string. In the special case of ADDITIONAL_DATA, if none is provided, the " - " prefixing it is not written.

Since:

4.3

Version:

4.3 (07/2018)

Author:

Grégory Mantelet (CDS)

Nested Class Summary

Nested classes/interfaces inherited from interface uws.service.log.UWSLog

UWSLog.LogLevel

Field Summary

Fields

Modifier and Type	Field and Description
protected static java.lang.String	DEFAULT_ROOT_LOG_ID Default SLF4J identifier for the general/root logger to use.
protected static java.lang.String	HTTP_LOG_ID_SUFFIX Suffix to append to the root logger ID for the HTTP logger.
protected org.slf4j.Logger	httpLogger Logger for HTTP requests and responses.
protected static java.lang.String	JOB_LOG_ID_SUFFIX Suffix to append to the root logger ID for the JOB logger.
protected org.slf4j.Logger	jobLogger Logger for UWS jobs actions.
protected org.slf4j.Logger	rootLogger General purpose logger.
protected static java.lang.String	THREAD_LOG_ID_SUFFIX Suffix to append to the root logger ID for the THREAD logger.
protected org.slf4j.Logger	threadLogger Logger for UWS jobs' threads actions.
protected static java.lang.String	UWS_LOG_ID_SUFFIX Suffix to append to the root logger ID for the UWS logger.
protected org.slf4j.Logger	uwsLogger Logger for general UWS actions.

Constructor Summary

Constructors

Modifier	Constructor and Description
	Slf4jUWSLog() Initialise this logger.
protected	Slf4jUWSLog(java.lang.String logId) Initialise this logger with the specified SLF4J logger.

Method Summary

Modifier and Type	Method and Description
void	debug(java.lang.String msg) Logs a debug message.
void	debug(java.lang.String msg, java.lang.Throwable t) Logs a full (message+exception) debug message.
void	debug(java.lang.Throwable t) Logs an exception as a debug message.
void	error(java.lang.String msg) Logs the given error.
void	error(java.lang.String msg, java.lang.Throwable t) Logs a full (message+exception) error message.
void	error(java.lang.Throwable t) Logs the given exception as an error.
java.lang.String	getConfigString() Get a string representing the configuration of this logger.
void	info(java.lang.String msg) Logs the given information.
protected void	log(UWSLog.LogLevel level, org.slf4j.Logger logger, java.lang.String event, java.lang.String ID, java.lang.String message, java.lang.String addColumn, java.lang.Throwable error) Logs a full message and/or error.
void	log(UWSLog.LogLevel level, java.lang.String context, java.lang.String message, java.lang.Throwable error) Generic way to log a message and/or an exception.
void	logHttp(UWSLog.LogLevel level, javax.servlet.http.HttpServletRequest request, java.lang.String requestId, java.lang.String message, java.lang.Throwable error) Log a message and/or an error in the HTTP context.
void	logHttp(UWSLog.LogLevel level, javax.servlet.http.HttpServletResponse response, java.lang.String requestId, JobOwner user, java.lang.String message, java.lang.Throwable error) Log a message and/or an error in the HTTP context.
void	logJob(UWSLog.LogLevel level, UWSJob job, java.lang.String event, java.lang.String message, java.lang.Throwable error) Log a message and/or an error in the JOB context.
void	logThread(UWSLog.LogLevel level, java.lang.Thread thread, java.lang.String event, java.lang.String message, java.lang.Throwable error) Log a message and/or an error in the THREAD context.
void	logUWS(UWSLog.LogLevel level, java.lang.Object obj, java.lang.String event, java.lang.String message, java.lang.Throwable error) Log a message and/or an error in the general context of UWS.
void	warning(java.lang.String msg) Logs the given warning.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_ROOT_LOG_ID

protected static final java.lang.String DEFAULT_ROOT_LOG_ID

Default SLF4J identifier for the general/root logger to use.

See Also:

Constant Field Values

UWS_LOG_ID_SUFFIX

protected static final java.lang.String UWS_LOG_ID_SUFFIX

Suffix to append to the root logger ID for the UWS logger.

See Also:

Constant Field Values

HTTP_LOG_ID_SUFFIX

protected static final java.lang.String HTTP_LOG_ID_SUFFIX

Suffix to append to the root logger ID for the HTTP logger.

See Also:

Constant Field Values

JOB_LOG_ID_SUFFIX

protected static final java.lang.String JOB_LOG_ID_SUFFIX

Suffix to append to the root logger ID for the JOB logger.

See Also:

Constant Field Values

THREAD_LOG_ID_SUFFIX

protected static final java.lang.String THREAD_LOG_ID_SUFFIX

Suffix to append to the root logger ID for the THREAD logger.

See Also:

Constant Field Values

rootLogger

protected final org.slf4j.Logger rootLogger

General purpose logger.

uwsLogger

protected final org.slf4j.Logger uwsLogger

Logger for general UWS actions.

httpLogger

protected final org.slf4j.Logger httpLogger

Logger for HTTP requests and responses.

jobLogger

protected final org.slf4j.Logger jobLogger

Logger for UWS jobs actions.

threadLogger

protected final org.slf4j.Logger threadLogger

Logger for UWS jobs' threads actions.

Constructor Detail

Slf4jUWSLog

public Slf4jUWSLog()

Initialise this logger.

Slf4jUWSLog

protected Slf4jUWSLog(java.lang.String logId)

Initialise this logger with the specified SLF4J logger.

Method Detail

getConfigString

public java.lang.String getConfigString()

Description copied from interface: UWSLog

Get a string representing the configuration of this logger.

The result of this function aims to be logged when the logging mechanism is successfully configured and ready to be used.

Specified by:

getConfigString in interface UWSLog

Returns:

String representing the configuration of this logger.

log

public void log(UWSLog.LogLevel level,
                java.lang.String context,
                java.lang.String message,
                java.lang.Throwable error)

Description copied from interface: UWSLog

Generic way to log a message and/or an exception.

Note: The other functions of this class or extension, MAY be equivalent to a call to this function with some specific parameter values. It should be especially the case for the debug(...), info(...), warning(...) and error(...) functions.

Specified by:

log in interface UWSLog

Parameters:

level - Level of the error (info, warning, error, ...). SHOULD NOT be NULL, but if NULL anyway, the level SHOULD be considered as INFO

context - Context of the log item (HTTP, Thread, Job, UWS, ...). MAY be NULL

message - Message to log. MAY be NULL

error - Error/Exception to log. MAY be NULL

log

protected final void log(UWSLog.LogLevel level,
                         org.slf4j.Logger logger,
                         java.lang.String event,
                         java.lang.String ID,
                         java.lang.String message,
                         java.lang.String addColumn,
                         java.lang.Throwable error)

Logs a full message and/or error.

Note: If no message and error is provided, nothing will be written.

Parameters:

level - Level of the error (DEBUG, INFO, WARNING, ERROR, FATAL). SHOULD NOT be NULL

logger - Logger to use. MUST NOT be NULL

event - Context event during which this log is emitted. MAY be NULL

ID - ID of the job or HTTP request (it may also be an ID of anything else). MAY BE NULL

message - Message of the error. MAY be NULL

addColumn - Additional column to append after the message and before the stack trace.

error - Error at the origin of the log error/warning/fatal. MAY be NULL

debug

public void debug(java.lang.String msg)

Description copied from interface: UWSLog

Logs a debug message.

Note: This function should be equals to: log(LogLevel.WARNING, null, msg, null)

Specified by:

debug in interface UWSLog

Parameters:

msg - A DEBUG message.

debug

public void debug(java.lang.Throwable t)

Description copied from interface: UWSLog

Logs an exception as a debug message.

Note: This function should be equals to: log(LogLevel.WARNING, null, null, t)

Specified by:

debug in interface UWSLog

Parameters:

t - An exception.

debug

public void debug(java.lang.String msg,
                  java.lang.Throwable t)

Description copied from interface: UWSLog

Logs a full (message+exception) debug message.

Note: This function should be equals to: log(LogLevel.WARNING, null, msg, t)

Specified by:

debug in interface UWSLog

Parameters:

msg - A DEBUG message.

t - An exception.

info

public void info(java.lang.String msg)

Description copied from interface: UWSLog

Logs the given information.

Note: This function should be equals to: log(LogLevel.INFO, null, msg, null)

Specified by:

info in interface UWSLog

Parameters:

msg - An INFO message.

warning

public void warning(java.lang.String msg)

Description copied from interface: UWSLog

Logs the given warning.

Note: This function should be equals to: log(LogLevel.WARNING, null, msg, null)

Specified by:

warning in interface UWSLog

Parameters:

msg - A WARNING message.

error

public void error(java.lang.String msg)

Description copied from interface: UWSLog

Logs the given error.

Note: This function should be equals to: log(LogLevel.ERROR, null, msg, null)

Specified by:

error in interface UWSLog

Parameters:

msg - An ERROR message.

error

public void error(java.lang.Throwable t)

Description copied from interface: UWSLog

Logs the given exception as an error.

Note: This function should be equals to: log(LogLevel.ERROR, null, null, t)

Specified by:

error in interface UWSLog

Parameters:

t - An exception.

error

public void error(java.lang.String msg,
                  java.lang.Throwable t)

Description copied from interface: UWSLog

Logs a full (message+exception) error message.

Note: This function should be equals to: log(LogLevel.ERROR, null, msg, t)

Specified by:

error in interface UWSLog

Parameters:

msg - An ERROR message.

t - An exception.

logHttp

public void logHttp(UWSLog.LogLevel level,
                    javax.servlet.http.HttpServletRequest request,
                    java.lang.String requestId,
                    java.lang.String message,
                    java.lang.Throwable error)

Description copied from interface: UWSLog

Log a message and/or an error in the HTTP context. This log function is called when a request is received by the service. Consequently, the event is: REQUEST_RECEIVED.

Note: When a request is received, this function is called, and then, when the response has been written and sent to the client, UWSLog.logHttp(LogLevel, HttpServletResponse, String, JobOwner, String, Throwable) should be called. These functions should always work together.

Specified by:

logHttp in interface UWSLog

Parameters:

level - Level of the log (info, warning, error, ...). SHOULD NOT be NULL, but if NULL anyway, the level SHOULD be considered as INFO

request - HTTP request received by the service. SHOULD NOT be NULL

requestId - ID to use to identify this request until its response is sent.

message - Message to log. MAY be NULL

error - Error/Exception to log. MAY be NULL

See Also:

UWSLog.logHttp(LogLevel, HttpServletResponse, String, JobOwner, String, Throwable)

logHttp

public void logHttp(UWSLog.LogLevel level,
                    javax.servlet.http.HttpServletResponse response,
                    java.lang.String requestId,
                    JobOwner user,
                    java.lang.String message,
                    java.lang.Throwable error)

Description copied from interface: UWSLog

Log a message and/or an error in the HTTP context. This log function is called when a response is sent to the client by the service. Consequently, the event is: RESPONSE_SENT.

Note: When a request is received, UWSLog.logHttp(LogLevel, HttpServletRequest, String, String, Throwable) is called, and then, when the response has been written and sent to the client, this function should be called. These functions should always work together.

Specified by:

logHttp in interface UWSLog

Parameters:

level - Level of the log (info, warning, error, ...). SHOULD NOT be NULL, but if NULL anyway, the level SHOULD be considered as INFO

response - HTTP response sent by the service to the client. MAY be NULL if an error occurs while writing the response

requestId - ID to use to identify the request to which the given response is answering.

user - Identified user which has sent the received request.

message - Message to log. MAY be NULL

error - Error/Exception to log. MAY be NULL

See Also:

UWSLog.logHttp(LogLevel, HttpServletRequest, String, String, Throwable)

logUWS

public void logUWS(UWSLog.LogLevel level,
                   java.lang.Object obj,
                   java.lang.String event,
                   java.lang.String message,
                   java.lang.Throwable error)

Description copied from interface: UWSLog

Log a message and/or an error in the general context of UWS.

One of the parameter is of type Object. This object can be used to provide more information to the log function in order to describe as much as possible the state and/or result event.

List of all events sent by the library (case sensitive):

• INIT (with "obj" as an instance of UWS except in case of error where "obj" is NULL)
• ADD_JOB_LIST (with "obj" as an instance of JobList)
• DESTROY_JOB_LIST (with "obj" as an instance of JobList)
• DESTROY_JOB (with "obj" as an instance of UWSUrl)
• SERIALIZE (with "obj" as an instance of UWSUrl)
• SET_PARAM (with "obj" as an instance of HttpServletRequest in case of error)
• GET_RESULT (with "obj" as an instance of Result)
• GET_ERROR (with "obj" as an instance of ErrorSummary)
• RESTORATION (with "obj" the raw object to de-serialize (may be JSONObject or JSONArray or NULL))
• BACKUP (with "obj" the object to backup ; may be JobOwner, a UWSJob, ...)
• RESTORED (with "obj" as an integer array of 4 items: nb of restored jobs, total nb of jobs, nb of restored users, total nb of users)
• BACKUPED (with "obj" as an integer array of 4 items: nb of saved jobs, total nb of jobs, nb of saved users, total nb of users or with just 2 items (the two last ones))
• FORMAT_ERROR (with a NULL "obj")
• STOP (with "obj" as an instance of UWS)

Specified by:

logUWS in interface UWSLog

Parameters:

level - Level of the log (info, warning, error, ...). SHOULD NOT be NULL, but if NULL anyway, the level SHOULD be considered as INFO

obj - Object providing more information about the event/object at the origin of this log. MAY be NULL

event - Event at the origin of this log or action currently executed by UWS while this log is sent. MAY be NULL

message - Message to log. MAY be NULL

error - Error/Exception to log. MAY be NULL

logJob

public void logJob(UWSLog.LogLevel level,
                   UWSJob job,
                   java.lang.String event,
                   java.lang.String message,
                   java.lang.Throwable error)

Description copied from interface: UWSLog

Log a message and/or an error in the JOB context.

List of all events sent by the library (case sensitive):

• CREATED
• QUEUE
• START
• ABORT
• ERROR
• ARCHIVE
• EXECUTING
• CHANGE_PHASE
• NOTIFY
• END
• SERIALIZE
• MOVE_UPLOAD
• ADD_RESULT
• SET_DESTRUCTION
• SET_ERROR
• CLEAR_RESOURCES
• DESTROY

Specified by:

logJob in interface UWSLog

Parameters:

level - Level of the log (info, warning, error, ...). SHOULD NOT be NULL, but if NULL anyway, the level SHOULD be considered as INFO

job - Job from which this log comes. MAY be NULL

event - Event at the origin of this log or action executed by the given job while this log is sent. MAY be NULL

message - Message to log. MAY be NULL

error - Error/Exception to log. MAY be NULL

logThread

public void logThread(UWSLog.LogLevel level,
                      java.lang.Thread thread,
                      java.lang.String event,
                      java.lang.String message,
                      java.lang.Throwable error)

Description copied from interface: UWSLog

Log a message and/or an error in the THREAD context.

List of all events sent by the library (case sensitive):

• START
• SET_ERROR
• END

Specified by:

logThread in interface UWSLog

Parameters:

level - Level of the log (info, warning, error, ...). SHOULD NOT be NULL, but if NULL anyway, the level SHOULD be considered as INFO

thread - Thread from which this log comes. MAY be NULL

event - Event at the origin of this log or action currently executed by the given thread while this log is sent. MAY be NULL

message - Message to log. MAY be NULL

error - Error/Exception to log. MAY be NULL