pl.mjaron.tinyloki

Class JsonLogStream

java.lang.Object

pl.mjaron.tinyloki.JsonLogStream

All Implemented Interfaces:

ILogStream

public class JsonLogStream
extends java.lang.Object
implements ILogStream

Writes logs to JSON-formatted string.

Constructor Summary

Constructors

Constructor and Description
JsonLogStream(JsonLogCollector collector, Labels labels) Constructor of stream.

Method Summary

Modifier and Type	Method and Description
void	clear() Drop old data and next prepare StringBuilder to start new chunk of stream.
void	closeStreamsEntryTag() Appends JSON tags which closes streams array and JSON root object.
java.lang.String	flush() Provide stream data and clear old logs.
java.lang.StringBuilder	getStringBuilder() Provides access to internal string builder for custom purposes.
void	log(long timestampMs, java.lang.String line) Thread-safe method used to write log messages to a stream.
void	release() Release log stream, so it isn't longer managed by its log collector.

Methods inherited from class java.lang.Object

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

Methods inherited from interface pl.mjaron.tinyloki.ILogStream

log

Constructor Detail

JsonLogStream

public JsonLogStream(JsonLogCollector collector,
                     Labels labels)

Constructor of stream. It should be created by JsonLogCollector.

Parameters:

collector - JsonLogCollector instance which manages this stream.

labels - Static labels related to this stream. There should not be two streams with the same set of static labels.

Method Detail

log

public void log(long timestampMs,
                java.lang.String line)

Description copied from interface: ILogStream

Thread-safe method used to write log messages to a stream.

Specified by:

log in interface ILogStream

Parameters:

timestampMs - Usually System.currentTimeMillis().

line - Log content.

release

public void release()

Description copied from interface: ILogStream

Release log stream, so it isn't longer managed by its log collector. It is not mandatory to call if this stream lifetime is the same as application lifetime.

Specified by:

release in interface ILogStream

closeStreamsEntryTag

public void closeStreamsEntryTag()

Appends JSON tags which closes streams array and JSON root object.

getStringBuilder

public java.lang.StringBuilder getStringBuilder()

Provides access to internal string builder for custom purposes. This method may be changed on any implementation changes.

Returns:

internal StringBuilder instance.

clear

public void clear()

Drop old data and next prepare StringBuilder to start new chunk of stream.

flush

public java.lang.String flush()

Provide stream data and clear old logs.

Returns:

JSON-formatted String containing single stream logs from last flush operation or from beginning of time. Null if this stream is empty.