Skip to content

Revamp the LogService #253

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
ctrueden wants to merge 18 commits into from
Closed

Revamp the LogService #253

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
18 commits
Select commit Hold shift + click to select a range
b02194d
Add LogLevel class to organize logging levels
ctrueden Dec 13, 2016
28debe6
AbstractLogService: refactor duplicate code
ctrueden Dec 13, 2016
ba52bb0
Migrate log level extraction to LogLevel class
ctrueden Dec 13, 2016
f00a495
Stop using deprecated log level constants
ctrueden Dec 13, 2016
2ba7742
Extract logging methods to a superinterface
ctrueden Dec 13, 2016
810b6b0
AbstractLogService: fix typo in javadoc
ctrueden Dec 14, 2016
1274d5f
AbstractLogService: fix incorrect comment
ctrueden Dec 14, 2016
3dd0445
Funnel all logging through a single method
ctrueden Dec 14, 2016
524c9c5
Split core logging logic into a dedicated class
ctrueden Dec 14, 2016
a045ef0
Make loggers have names
ctrueden Dec 14, 2016
0dd11f3
Add support for multiple logging channels
ctrueden Dec 14, 2016
214d8ba
LogService: add a method to obtain all channels
ctrueden Dec 14, 2016
ecacae1
Add a callback for logging events
ctrueden Dec 14, 2016
0f89bd7
Add a simple unit test for Logger
ctrueden Dec 14, 2016
7f310d3
Simplify/improve prefix logic
ctrueden Dec 15, 2016
edc368f
DefaultConsoleService: initialize eagerly
ctrueden Dec 21, 2016
e227e4c
ConsoleService: publish stdout/stderr to the log
ctrueden Dec 21, 2016
9e2aa2d
ConsoleServiceTest: check that messages are logged
ctrueden Dec 21, 2016
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
92 changes: 82 additions & 10 deletions src/main/java/org/scijava/console/DefaultConsoleService.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,9 @@

import org.scijava.Context;
import org.scijava.console.OutputEvent.Source;
import org.scijava.log.LogLevel;
import org.scijava.log.LogService;
import org.scijava.log.Logger;
import org.scijava.plugin.AbstractHandlerService;
import org.scijava.plugin.Parameter;
import org.scijava.plugin.Plugin;
Expand All @@ -58,12 +60,18 @@ public class DefaultConsoleService extends
ConsoleService
{

private static final String STDOUT_LOG_CHANNEL = "stdout";
private static final String STDERR_LOG_CHANNEL = "stderr";

@Parameter
private ThreadService threadService;

@Parameter
private LogService log;

private Logger stdoutLogger;
private Logger stderrLogger;

private MultiPrintStream sysout, syserr;
private OutputStreamReporter out, err;

Expand Down Expand Up @@ -138,6 +146,80 @@ public void notifyListeners(final OutputEvent event) {
l.outputOccurred(event);
}

// -- Initializable methods --

@Override
public void initialize() {
// intercept messages on sysout
sysout = multiPrintStream(System.out);
if (System.out != sysout) System.setOut(sysout);
out = new OutputStreamReporter(Source.STDOUT);
sysout.getParent().addOutputStream(out);

// intercept messages on syserr
syserr = multiPrintStream(System.err);
if (System.err != syserr) System.setErr(syserr);
err = new OutputStreamReporter(Source.STDERR);
syserr.getParent().addOutputStream(err);

// publish stdout and stderr messages on dedicated log channels
stdoutLogger = log.channel(STDOUT_LOG_CHANNEL);
stderrLogger = log.channel(STDERR_LOG_CHANNEL);
addOutputListener(new OutputListener() {

private StringBuilder outBuf = new StringBuilder();
private StringBuilder errBuf = new StringBuilder();

@Override
public void outputOccurred(final OutputEvent event) {
if (event.isStderr()) {
log(stderrLogger, LogLevel.ERROR, event.getOutput(), errBuf);
}
else if (event.isStdout()) {
log(stdoutLogger, LogLevel.INFO, event.getOutput(), outBuf);
}
}

/**
* Clever logging method which accumulates output, flushing to the log
* channel whenever a newline is encountered.
* <p>
* Note that if a newline is encountered <em>anywhere</em> in the string,
* the <em>entire</em> accumulated buffer is flushed. Messages ending in
* a newline have one newline stripped. Here are some examples:
* </p>
*
* <pre>
* ['foo', '\n'] -> 'foo'
* ['foo\n'] -> 'foo'
* ['foo\nbar'] -> 'foo\nbar'
* ['foo', '\nbar'] -> 'foo\nbar'
* ['foo', 'abc\ndef'] -> 'fooabc\ndef'
* ['foo', 'abc\ndef\n'] -> 'fooabc\ndef'
* ['foo\nbar\n\n'] -> 'foo\nbar\n'
* </pre>
*/
private void log(final Logger logger, final int level,
final String output, final StringBuilder buf)
{
if (output.contains("\n")) {
// append the completed message
buf.append(output);
// strip one trailing newline, if any
if (output.endsWith("\n")) buf.setLength(buf.length() - 1);
// flush the buffer
final String message = buf.toString();
if (!message.isEmpty()) logger.log(level, message);
buf.setLength(0);
}
else {
// message was a fragment; append but do not flush
buf.append(output);
}
}
});
}

// -- Disposable methods --

@Override
Expand All @@ -152,16 +234,6 @@ public void dispose() {
private synchronized void initListeners() {
if (listeners != null) return; // already initialized

sysout = multiPrintStream(System.out);
if (System.out != sysout) System.setOut(sysout);
out = new OutputStreamReporter(Source.STDOUT);
sysout.getParent().addOutputStream(out);

syserr = multiPrintStream(System.err);
if (System.err != syserr) System.setErr(syserr);
err = new OutputStreamReporter(Source.STDERR);
syserr.getParent().addOutputStream(err);

listeners = new ArrayList<>();
cachedListeners = listeners.toArray(new OutputListener[0]);
}
Expand Down
Loading