Skip to content

Commit

Permalink
Merge pull request #4 from GoodforGod/dev
Browse files Browse the repository at this point in the history 
[0.13.0]
  • Loading branch information
@GoodforGod
GoodforGod authored Mar 15, 2022
2 parents eae1e9e + 7feaeb2 commit b437a40
Show file tree
Hide file tree
Showing 10 changed files with 579 additions and 295 deletions.
4 changes: 2 additions & 2 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -25,15 +25,15 @@ Java 11+ compatible.

[**Gradle**](https://mvnrepository.com/artifact/io.goodforgod/slf4j-simple-logger)
```groovy
implementation "io.goodforgod:slf4j-simple-logger:0.12.0"
implementation "io.goodforgod:slf4j-simple-logger:0.13.0"
```

[**Maven**](https://mvnrepository.com/artifact/io.goodforgod/slf4j-simple-logger)
```xml
<dependency>
<groupId>io.goodforgod</groupId>
<artifactId>slf4j-simple-logger</artifactId>
<version>0.12.0</version>
<version>0.13.0</version>
</dependency>
```

Expand Down
2 changes: 1 addition & 1 deletion gradle.properties
View file
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
groupId=io.goodforgod
artifactId=slf4j-simple-logger
artifactVersion=0.12.0
artifactVersion=0.13.0


##### GRADLE #####
Expand Down
27 changes: 27 additions & 0 deletions src/main/java/io/goodforgod/slf4j/simplelogger/Layout.java
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
package io.goodforgod.slf4j.simplelogger;

/**
* Used to print part of logger layout
*
* @author Anton Kurako (GoodforGod)
* @since 14.03.2022
*/
interface Layout extends Comparable<Layout> {

/**
* @param loggerName of the logger invoked
* @param level of the logger invoked
* @param builder to append layout
*/
void print(String loggerName, int level, StringBuilder builder);

/**
* @return order layout compared to all others layouts
*/
int order();

@Override
default int compareTo(Layout o) {
return Integer.compare(order(), o.order());
}
}
255 changes: 38 additions & 217 deletions src/main/java/io/goodforgod/slf4j/simplelogger/SimpleLogger.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,9 @@
import static io.goodforgod.slf4j.simplelogger.SimpleLoggerProperties.PREFIX_LOG;

import java.io.*;
import java.time.LocalDateTime;
import java.time.LocalTime;
import java.nio.charset.Charset;
import java.util.List;
import java.util.concurrent.locks.Lock;
import org.slf4j.Logger;
import org.slf4j.event.LoggingEvent;
import org.slf4j.helpers.FormattingTuple;
Expand Down Expand Up @@ -118,14 +119,14 @@
* @author Anton Kurako (GoodforGod)
* @since 09.10.2021
*/
public class SimpleLogger extends MarkerIgnoringBase {
public final class SimpleLogger extends MarkerIgnoringBase {

protected static final int LOG_LEVEL_TRACE = LocationAwareLogger.TRACE_INT;
protected static final int LOG_LEVEL_DEBUG = LocationAwareLogger.DEBUG_INT;
protected static final int LOG_LEVEL_INFO = LocationAwareLogger.INFO_INT;
protected static final int LOG_LEVEL_WARN = LocationAwareLogger.WARN_INT;
protected static final int LOG_LEVEL_ERROR = LocationAwareLogger.ERROR_INT;
protected static final int LOG_LEVEL_OFF = LOG_LEVEL_ERROR + 10;
static final int LOG_LEVEL_TRACE = LocationAwareLogger.TRACE_INT;
static final int LOG_LEVEL_DEBUG = LocationAwareLogger.DEBUG_INT;
static final int LOG_LEVEL_INFO = LocationAwareLogger.INFO_INT;
static final int LOG_LEVEL_WARN = LocationAwareLogger.WARN_INT;
static final int LOG_LEVEL_ERROR = LocationAwareLogger.ERROR_INT;
static final int LOG_LEVEL_OFF = LOG_LEVEL_ERROR + 10;

private static final SimpleLoggerConfiguration CONFIG = new SimpleLoggerConfiguration();

Expand All @@ -150,27 +151,24 @@ static void init() {
/**
* The current log level
*/
protected int currentLogLevel;
protected final int originalLogLevel;
int currentLogLevel;
final int originalLogLevel;
/**
* The short name of this simple log instance
*/
private final transient String logName;
private final transient String logNameShort;
final String logName;

/**
* Package access allows only {@link SimpleLoggerFactory} to instantiate SimpleLogger instances.
*/
SimpleLogger(String name) {
this.name = name;
this.logNameShort = computeShortName() + " - ";
this.logName = (CONFIG.logNameLength == null)
? name + " - "
: ClassNameAbbreviator.abbreviate(name, CONFIG.logNameLength) + " - ";
this.logName = CONFIG.computeLogName(name);

final String levelString = recursivelyComputeLevelString();
this.currentLogLevel = (levelString != null)
? SimpleLoggerConfiguration.tryStringToLevel(levelString).orElse(LOG_LEVEL_INFO)
: CONFIG.defaultLogLevel;
: CONFIG.getDefaultLogLevel();
this.originalLogLevel = this.currentLogLevel;
}

Expand Down Expand Up @@ -203,60 +201,10 @@ private void log(int level, String message, Throwable throwable) {
return;
}

final String threadName = (CONFIG.showThreadName)
? Thread.currentThread().getName()
: null;

final int length = predictBuilderLength(message, threadName, throwable);
final StringBuilder builder = new StringBuilder(length);

// Append date-time if so configured
if (CONFIG.showDateTime) {
switch (CONFIG.dateTimeOutputType) {
case DATE_TIME:
builder.append(getFormattedDateTime());
break;
case TIME:
builder.append(getFormattedTime());
break;
case UNIX_TIME:
builder.append(System.currentTimeMillis());
break;
case MILLIS_FROM_START:
builder.append(System.currentTimeMillis() - CONFIG.initializeTime);
break;
}

builder.append(' ');
}

// Append package implementation version
if (CONFIG.showImplementationVersion) {
builder.append('[');
builder.append(CONFIG.implementationVersion);
builder.append("] ");
}

// Append a readable representation of the log level
final String levelStr = (CONFIG.levelInBrackets)
? renderLevelInBrackets(level)
: renderLevel(level);
builder.append(levelStr);

logEnvironment(builder);

// Append current thread name if so configured
if (CONFIG.showThreadName) {
builder.append('[');
builder.append(threadName);
builder.append("] ");
}

// Append the name of the log instance if so configured
if (CONFIG.showShortLogName) {
builder.append(logNameShort);
} else if (CONFIG.showLogName) {
builder.append(logName);
final StringBuilder builder = new StringBuilder();
final List<Layout> layouts = CONFIG.getLayouts();
for (Layout layout : layouts) {
layout.print(logName, level, builder);
}

// Append the message
Expand All @@ -270,161 +218,34 @@ private void log(int level, String message, Throwable throwable) {
throwable.printStackTrace(printWriter);
}

write(builder);
}

private void logEnvironment(StringBuilder builder) {
if (CONFIG.environments.isEmpty()) {
return;
}

if (CONFIG.environmentsOnStart != null) {
builder.append(CONFIG.environmentsOnStart);
} else {
boolean bracketUsed = false;
for (String envName : CONFIG.environments) {
final String envValue = System.getenv(envName);
if (envValue == null && !CONFIG.environmentShowNullable) {
continue;
}

if (!bracketUsed) {
builder.append('[');
bracketUsed = true;
} else {
builder.append(", ");
}

if (CONFIG.environmentShowName) {
builder.append(envName);
builder.append('=');
}

builder.append(envValue);
}

if (bracketUsed) {
builder.append("] ");
}
}
}

private int predictBuilderLength(String message, String threadName, Throwable throwable) {
int length = 14;

if (message != null)
length += message.length();
if (throwable != null)
length += 2048;
if (threadName != null)
length += threadName.length();
if (CONFIG.showDateTime)
length += 24;

if (CONFIG.environmentsOnStart != null) {
length += CONFIG.environmentsOnStart.length();
} else {
for (String env : CONFIG.environments) {
length += (CONFIG.environmentShowName)
? env.length() + 6
: 10;
}
}

if (CONFIG.showImplementationVersion)
length += CONFIG.implementationVersion.length() + 4;
if (CONFIG.showShortLogName) {
length += logNameShort.length();
} else if (CONFIG.showLogName) {
length += logName.length();
}

return length;
}

protected String renderLevel(int level) {
switch (level) {
case LOG_LEVEL_INFO:
return "INFO ";
case LOG_LEVEL_WARN:
return "WARN ";
case LOG_LEVEL_ERROR:
return "ERROR ";
case LOG_LEVEL_DEBUG:
return "DEBUG ";
case LOG_LEVEL_TRACE:
return "TRACE ";
default:
throw new IllegalStateException("Unrecognized level [" + level + "]");
}
}

protected String renderLevelInBrackets(int level) {
switch (level) {
case LOG_LEVEL_INFO:
return "[INFO] ";
case LOG_LEVEL_WARN:
return "[WARN] ";
case LOG_LEVEL_ERROR:
return "[ERROR] ";
case LOG_LEVEL_DEBUG:
return "[DEBUG] ";
case LOG_LEVEL_TRACE:
return "[TRACE] ";
default:
throw new IllegalStateException("Unrecognized level [" + level + "]");
}
write(level, builder.toString());
}

/**
* To avoid intermingling of log messages and associated stack traces, the two operations are done
* in a synchronized block.
*
* @param builder of logging message
* @param message of logging message
*/
void write(StringBuilder builder) {
final String message = builder.toString();
final byte[] bytes = (CONFIG.charset == null)
void write(int level, String message) {
final Charset charset = CONFIG.getCharset();
final byte[] bytes = (charset == null)
? message.getBytes()
: message.getBytes(CONFIG.charset);

final PrintStream printStream = getOutputStream();
synchronized (printStream) {
try {
printStream.write(bytes);
printStream.flush();
} catch (IOException e) {
// do nothing
}
: message.getBytes(charset);

final PrintStream printStream = CONFIG.getOutputStream(level);
final Lock lock = CONFIG.getLock();
lock.lock();
try {
printStream.write(bytes);
printStream.flush();
} catch (IOException e) {
// do nothing
} finally {
lock.unlock();
}
}

private PrintStream getOutputStream() {
if (CONFIG.sameOutputChoice)
return CONFIG.outputChoice.getTargetPrintStream();

switch (currentLogLevel) {
case LOG_LEVEL_WARN:
return CONFIG.outputChoiceWarn.getTargetPrintStream();
case LOG_LEVEL_ERROR:
return CONFIG.outputChoiceError.getTargetPrintStream();
default:
return CONFIG.outputChoice.getTargetPrintStream();
}
}

private String getFormattedDateTime() {
return CONFIG.dateTimeFormatter.format(LocalDateTime.now());
}

private String getFormattedTime() {
return CONFIG.dateTimeFormatter.format(LocalTime.now());
}

private String computeShortName() {
return name.substring(name.lastIndexOf('.') + 1);
}

/**
* For formatted messages, first substitute arguments and then log.
*
Expand Down Expand Up @@ -481,7 +302,7 @@ private void formatAndLog(int level, String format, Object... arguments) {
* @param logLevel is this level enabled?
* @return true if enabled
*/
protected boolean isLevelEnabled(int logLevel) {
boolean isLevelEnabled(int logLevel) {
return (logLevel >= currentLogLevel);
}

Expand Down
Loading

0 comments on commit b437a40

Please sign in to comment.