public class LogController
extends java.lang.Object
start() creates worker thread which sends new logs, so should be called
when application starts.| Constructor and Description |
|---|
LogController(ILogCollector logCollector,
ILogEncoder logEncoder,
LogSenderSettings logSenderSettings,
ILogSender logSender,
LabelSettings labelSettings,
ILogMonitor logMonitor)
Main constructor designed for user of this library.
|
LogController(ILogCollector logCollector,
LogSenderSettings logSenderSettings,
ILogSender logSender,
LabelSettings labelSettings,
ILogMonitor logMonitor)
Deprecated.
Use
LogController(ILogCollector, ILogEncoder, LogSenderSettings, ILogSender, LabelSettings, ILogMonitor) instead, where logEncoder parameter should be specified explicitly. |
| Modifier and Type | Method and Description |
|---|---|
ILogStream |
createStream(Labels labels)
Creates new stream from log collector.
|
ILogStream |
createStream(java.util.Map<java.lang.String,java.lang.String> labels)
Creates new stream from log collector.
|
LogController |
hardStop()
Blocking function.
|
LogController |
hardStop(long interruptTimeout)
Interrupts worker thread and tries to join for given interruptTimeout.
|
boolean |
isHardStopped()
Tells whether worker thread exited or not.
|
boolean |
isSoftStopped()
Tells if worker thread has stopped softly, doing all its work before exiting.
|
LogController |
softStop()
Blocking function.
|
LogController |
softStop(long softTimeout)
Blocking function.
|
LogController |
softStopAsync()
Request worker thread to do last jobs.
|
LogController |
start()
Starts worker thread which is responsible for collecting and sending logs.
|
StreamBuilder |
stream()
Provides a
StreamBuilder to initialize the stream. |
void |
workerLoop()
Defines worker thread activity.
|
public LogController(ILogCollector logCollector, ILogEncoder logEncoder, LogSenderSettings logSenderSettings, ILogSender logSender, LabelSettings labelSettings, ILogMonitor logMonitor)
logCollector - ILogCollector implementation, which is responsible for creating new streams and collecting its logs.logEncoder - Optional (may be null) log encoder which is responsible for encode whole log message.logSenderSettings - LogSenderSettings used to initialize the log sender.
Some settings will be overridden by this constructor.logSender - Sends the logs collected by log controller.labelSettings - Preferences of the Labels. See LabelSettings.logMonitor - Handles diagnostic events from whole library.public LogController(ILogCollector logCollector, LogSenderSettings logSenderSettings, ILogSender logSender, LabelSettings labelSettings, ILogMonitor logMonitor)
LogController(ILogCollector, ILogEncoder, LogSenderSettings, ILogSender, LabelSettings, ILogMonitor) instead, where logEncoder parameter should be specified explicitly.logCollector - ILogCollector implementation, which is responsible for creating new streams and collecting its logs.logSenderSettings - LogSenderSettings used to initialize the log sender.
Some settings will be overridden by this constructor.logSender - Sends the logs collected by log controller.labelSettings - Preferences of the Labels. See LabelSettings.logMonitor - Handles diagnostic events from whole library.public ILogStream createStream(java.util.Map<java.lang.String,java.lang.String> labels)
labels - Static labels. There shouldn't be many streams with the same labels combination.public ILogStream createStream(Labels labels)
labels - Static labels. There shouldn't be many streams with the same labels combination.public StreamBuilder stream()
StreamBuilder to initialize the stream. E.g:
ILogStream myStream = logController.stream().info().l("my_custom_label", "value").build();
StreamBuilder.public LogController start()
public LogController softStopAsync()
public boolean isHardStopped()
public LogController hardStop(long interruptTimeout)
interruptTimeout - Timeout in milliseconds.public LogController hardStop()
hardStop(long)public LogController softStop(long softTimeout)
softTimeout - Timeout in milliseconds.public LogController softStop()
softStop(long)public boolean isSoftStopped()
public void workerLoop()