pl.mjaron.tinyloki

Class LogController

java.lang.Object

pl.mjaron.tinyloki.LogController

public class LogController
extends java.lang.Object

Organizes cooperation between collector and sender. Method start() creates worker thread which sends new logs, so should be called when application starts.

Constructor Summary

Constructors

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.

Method Summary

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.

Methods inherited from class java.lang.Object

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

Constructor Detail

LogController

public LogController(ILogCollector logCollector,
                     ILogEncoder logEncoder,
                     LogSenderSettings logSenderSettings,
                     ILogSender logSender,
                     LabelSettings labelSettings,
                     ILogMonitor logMonitor)

Main constructor designed for user of this library.

Parameters:

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.

Since:

0.3.4

LogController

public 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.

Maintenance constructor designed for user of this library.

Parameters:

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.

Method Detail

createStream

public ILogStream createStream(java.util.Map<java.lang.String,java.lang.String> labels)

Creates new stream from log collector.

Parameters:

labels - Static labels. There shouldn't be many streams with the same labels combination.

Returns:

New stream reference.

createStream

public ILogStream createStream(Labels labels)

Creates new stream from log collector.

Parameters:

labels - Static labels. There shouldn't be many streams with the same labels combination.

Returns:

New stream reference.

stream

public StreamBuilder stream()

Provides a StreamBuilder to initialize the stream. E.g:

 ILogStream myStream = logController.stream().info().l("my_custom_label", "value").build();
 

Returns:

New instance of StreamBuilder.

start

public LogController start()

Starts worker thread which is responsible for collecting and sending logs.

Returns:

This reference.

softStopAsync

public LogController softStopAsync()

Request worker thread to do last jobs. This method is non-blocking.

Returns:

This reference.

isHardStopped

public boolean isHardStopped()

Tells whether worker thread exited or not.

Returns:

True if worker thread is terminated.

hardStop

public LogController hardStop(long interruptTimeout)

Interrupts worker thread and tries to join for given interruptTimeout.

Parameters:

interruptTimeout - Timeout in milliseconds.

Returns:

This reference.

hardStop

public LogController hardStop()

Blocking function. Request to stop worker thread by interrupting it. Waits for interruption with default timeout.

Returns:

This reference.

See Also:

hardStop(long)

softStop

public LogController softStop(long softTimeout)

Blocking function. Tells to worker to send logs to this time point and exit.

Parameters:

softTimeout - Timeout in milliseconds.

Returns:

This reference.

softStop

public LogController softStop()

Blocking function. Soft stop with default timeout.

Returns:

This reference.

See Also:

softStop(long)

isSoftStopped

public boolean isSoftStopped()

Tells if worker thread has stopped softly, doing all its work before exiting.

Returns:

True if worker thread has exited without interruption.

workerLoop

public void workerLoop()

Defines worker thread activity.