Skip to content

Commit

Permalink
Added JobLogger.warn(...) methods
Browse files Browse the repository at this point in the history 
Signed-off-by: coduz <alberto.codutti@eurotech.com>
  • Loading branch information
@Coduz
Coduz committed Feb 11, 2019
1 parent 6b097e7 commit 47312c9
Showing 1 changed file with 100 additions and 11 deletions.
111 changes: 100 additions & 11 deletions job-engine/commons/src/main/java/org/eclipse/kapua/job/engine/commons/logger/JobLogger.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@
import org.eclipse.kapua.service.job.execution.JobExecution;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.slf4j.event.Level;

import java.text.MessageFormat;
import java.util.ArrayList;
Expand Down Expand Up @@ -44,6 +45,7 @@ public class JobLogger {
private static final String PRE_STD_LOG_FORMAT_EXECUTION_ID = "ExecutionId: {} - ";

private static final String PRE_EXEC_LOG_FORMAT_LEVEL_INFO = "[INFO] ";
private static final String PRE_EXEC_LOG_FORMAT_LEVEL_WARN = "[WARN] ";
private static final String PRE_EXEC_LOG_FORMAT_LEVEL_ERROR = "[ERROR] ";
private static final String PRE_EXEC_LOG_FORMAT_DATE = "{} - ";
private static final String POST_EXEC_LOG_FORMAT_ERROR = " {}";
Expand Down Expand Up @@ -91,7 +93,7 @@ public void setClassLog(Logger classLog) {
}

/**
* Logs a log line of {@link java.util.logging.Level#INFO}.
* Logs a log line of {@link Level#INFO}.
*
* @param message The {@link String} to log.
*/
Expand All @@ -100,16 +102,15 @@ public void info(String message) {
}

/**
* Logs a log line of {@link java.util.logging.Level#INFO} with the given arguments.
* Logs a log line of {@link Level#INFO} with the given arguments.
*
* @param format The {@link String} format for the log line.
* @param arguments The {@link java.util.Objects}... to populate the given format.
*/
public void info(String format, Object... arguments) {

if (StringUtils.countMatches(format, "{}") != arguments.length) {
LOG.warn("Format string tokens do not match number of arguments");
}
checkFormatAndArguments(format, arguments);

try {
//
// Standard Logging
Expand Down Expand Up @@ -142,7 +143,79 @@ public void info(String format, Object... arguments) {
}

/**
* Logs a log line of {@link java.util.logging.Level#SEVERE}.
* Logs a log line of {@link Level#WARN}.
*
* @param message The {@link String} to log.
*/
public void warn(String message) {
warn(null, message);
}

/**
* Logs a log line of {@link Level#WARN} with the relative {@link Exception}.
* <p>
* Into the {@link JobExecution} log only {@link Exception#getMessage()} will be logged.
*
* @param exception The {@link Exception} to log.
* @param message The {@link String} to log.
*/
public void warn(Exception exception, String message) {
warn(exception, message, Collections.emptyList().toArray());
}

/**
* Logs a log line of {@link Level#WARN} with the relative {@link Exception} with the given arguments.
* <p>
* Into the {@link JobExecution} log only {@link Exception#getMessage()} will be logged.
*
* @param exception The {@link Exception} to log.
* @param format The {@link String} to log.
* @param arguments The {@link java.util.Objects}... to populate the given format.
*/
public void warn(Exception exception, String format, Object... arguments) {

checkFormatAndArguments(format, arguments);

try {
//
// Standard Logging
if (containerClassLog.isErrorEnabled()) {
StringBuilder formatSb = new StringBuilder();
List<Object> finalArguments = new ArrayList<>();

buildStdLogFormatArguments(format, arguments, formatSb, finalArguments);

tokenizeFormat(formatSb);

containerClassLog.warn(MessageFormat.format(formatSb.toString(), finalArguments.toArray()), exception);
}

//
// Job Execution Logging
StringBuilder formatSb = new StringBuilder();
formatSb.append(PRE_EXEC_LOG_FORMAT_LEVEL_WARN);
formatSb.append(PRE_EXEC_LOG_FORMAT_DATE);
formatSb.append(format);

List<Object> finalArguments = new ArrayList<>();
finalArguments.add(new Date());
finalArguments.addAll(Arrays.asList(arguments));

if (exception != null) {
formatSb.append(POST_EXEC_LOG_FORMAT_ERROR);
finalArguments.add(exception.getMessage());
}

tokenizeFormat(formatSb);

logSb.append(MessageFormat.format(formatSb.toString(), finalArguments.toArray())).append(LF);
} catch (Exception e) {
LOG.error("Cannot log this line: " + format, e);
}
}

/**
* Logs a log line of {@link Level#ERROR}.
*
* @param message The {@link String} to log.
*/
Expand All @@ -151,7 +224,7 @@ public void error(String message) {
}

/**
* Logs a log line of {@link java.util.logging.Level#SEVERE} with the relative {@link Exception}.
* Logs a log line of {@link Level#ERROR} with the relative {@link Exception}.
* <p>
* Into the {@link JobExecution} log only {@link Exception#getMessage()} will be logged.
*
Expand All @@ -163,7 +236,7 @@ public void error(Exception exception, String message) {
}

/**
* Logs a log line of {@link java.util.logging.Level#SEVERE} with the relative {@link Exception} with the given arguments.
* Logs a log line of {@link Level#ERROR} with the relative {@link Exception} with the given arguments.
* <p>
* Into the {@link JobExecution} log only {@link Exception#getMessage()} will be logged.
*
Expand All @@ -172,9 +245,8 @@ public void error(Exception exception, String message) {
* @param arguments The {@link java.util.Objects}... to populate the given format.
*/
public void error(Exception exception, String format, Object... arguments) {
if (StringUtils.countMatches(format, "{}") != arguments.length) {
LOG.warn("Format string tokens do not match number of arguments");
}

checkFormatAndArguments(format, arguments);

try {
//
Expand Down Expand Up @@ -227,10 +299,27 @@ public synchronized String flush() {
return log;
}


//
// Private methods
//

/**
* Checks that the number of placeholders in the given format matches the number of arguments given.
* If they do not match, a {@link Logger#warn(String)} is printed in the {@link JobLogger#LOG}.
* <p>
* Counts occurrences of {@code {}} in the given {@code format} parameter and
* matches with the {@code length} of the {@code arguments} parameter.
*
* @param format The {@link String} format to check.
* @param arguments The {@link List} of arguments to check.
*/
private void checkFormatAndArguments(String format, Object... arguments) {
if (StringUtils.countMatches(format, "{}") != arguments.length) {
LOG.warn("Format string tokens do not match number of arguments");
}
}

/**
* Build the log line for the standard log of the application.
* <p>
Expand Down

0 comments on commit 47312c9

Please sign in to comment.