tap.log

Class Slf4jTAPLog

java.lang.Object

uws.service.log.Slf4jUWSLog

tap.log.Slf4jTAPLog

All Implemented Interfaces:

TAPLog, UWSLog

public class Slf4jTAPLog
extends Slf4jUWSLog
implements TAPLog

This implementation of TAPLog forwards all log submission to SLF4J.

Thus, a TAP 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:

"tap.service"{SUFFIX}

The ID of the general/root logger is just "tap.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:

2.3

Version:

2.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	DB_LOG_ID_SUFFIX Suffix to append to the root logger ID for the DATABASE logger.
protected org.slf4j.Logger	dbLogger Logger for database actions.
protected static java.lang.String	DEFAULT_ROOT_LOG_ID Default SLF4J identifier for the general/root logger to use.
protected static java.lang.String	TAP_LOG_ID_SUFFIX Suffix to append to the root logger ID for the TAP logger.
protected org.slf4j.Logger	tapLogger Logger for TAP jobs actions.

Fields inherited from class uws.service.log.Slf4jUWSLog

HTTP_LOG_ID_SUFFIX, httpLogger, JOB_LOG_ID_SUFFIX, jobLogger, rootLogger, THREAD_LOG_ID_SUFFIX, threadLogger, UWS_LOG_ID_SUFFIX, uwsLogger

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
java.lang.String	getConfigString() Get a string representing the configuration of this logger.
void	logDB(UWSLog.LogLevel level, DBConnection connection, java.lang.String event, java.lang.String message, java.lang.Throwable error) Log a message and/or an error in the DB (database) context.
void	logTAP(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 TAP.

Methods inherited from class uws.service.log.Slf4jUWSLog

debug, debug, debug, error, error, error, info, log, log, logHttp, logHttp, logJob, logThread, logUWS, warning

Methods inherited from class java.lang.Object

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

Methods inherited from interface uws.service.log.UWSLog

debug, debug, debug, error, error, error, info, log, logHttp, logHttp, logJob, logThread, logUWS, warning

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

TAP_LOG_ID_SUFFIX

protected static final java.lang.String TAP_LOG_ID_SUFFIX

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

See Also:

Constant Field Values

DB_LOG_ID_SUFFIX

protected static final java.lang.String DB_LOG_ID_SUFFIX

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

See Also:

Constant Field Values

tapLogger

protected final org.slf4j.Logger tapLogger

Logger for TAP jobs actions.

dbLogger

protected final org.slf4j.Logger dbLogger

Logger for database actions.

Constructor Detail

Slf4jTAPLog

public Slf4jTAPLog()

Initialise this logger.

Slf4jTAPLog

protected Slf4jTAPLog(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

Overrides:

getConfigString in class Slf4jUWSLog

Returns:

String representing the configuration of this logger.

logDB

public void logDB(UWSLog.LogLevel level,
                  DBConnection connection,
                  java.lang.String event,
                  java.lang.String message,
                  java.lang.Throwable error)

Description copied from interface: TAPLog

Log a message and/or an error in the DB (database) context.

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

• CONNECTION_LACK
• TRANSLATE
• EXECUTE
• RESULT
• LOAD_TAP_SCHEMA
• CLEAN_TAP_SCHEMA
• CREATE_TAP_SCHEMA
• TABLE_EXIST
• COLUMN_EXIST
• EXEC_UPDATE
• ADD_UPLOAD_TABLE
• DROP_UPLOAD_TABLE
• START_TRANSACTION
• COMMIT
• ROLLBACK
• END_TRANSACTION
• CLOSE

Specified by:

logDB in interface TAPLog

Parameters:

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

connection - DB connection from which this log comes. MAY be NULL

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

message - Message to log. MAY be NULL

error - Error/Exception to log. MAY be NULL

logTAP

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

Description copied from interface: TAPLog

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

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):

• IDENT_USER (with a NULL "obj")
• SYNC_INIT (with "obj" as an instance of TAPParameters)
• ASYNC_INIT (with a NULL "obj")
• START (with "obj" as an instance of TAPSyncJob)
• UPLOADING (with "obj" as an instance of TAPExecutionReport)
• PARSING (with "obj" as an instance of TAPExecutionReport)
• START_DB_EXECUTION (with "obj" as an instance of TAPExecutionReport)
• WRITING_RESULT (with "obj" as an instance of TAPExecutionReport)
• RESULT_WRITTEN (with "obj" as an instance of TAPExecutionReport)
• START_STEP (with "obj" as an instance of TAPExecutionReport)
• END_EXEC (with "obj" as an instance of TAPExecutionReport)
• END_DB_EXECUTION (with "obj" as an instance of TAPExecutionReport)
• DROP_UPLOAD (with "obj" as an instance of TAPExecutionReport)
• TIME_OUT (with "obj" as an instance of TAPSyncJob)
• END (with "obj" as an instance of TAPSyncJob)

Specified by:

logTAP in interface TAPLog

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 TAP while this log is sent. MAY be NULL

message - Message to log. MAY be NULL

error - Error/Exception to log. MAY be NULL