pl.mjaron.tinyloki

Class StreamBuilder

java.lang.Object

pl.mjaron.tinyloki.StreamBuilder

public class StreamBuilder
extends java.lang.Object

Helper class for shorter initialization code. call build() to initialize ILogStream with parameters passed to this builder. Example:

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

Constructor Summary

Constructors

Constructor and Description
StreamBuilder(LogController logController)

Method Summary

Modifier and Type	Method and Description
ILogStream	build() Create stream with previously defined labels.
StreamBuilder	critical() Sets label level to Labels.FATAL, the same as fatal().
StreamBuilder	debug() Sets label level to Labels.DEBUG.
StreamBuilder	fatal() Sets label level to Labels.FATAL.
Labels	getLabels() Provides access to internal Labels object.
StreamBuilder	info() Sets label level to Labels.INFO.
StreamBuilder	l(Labels labels) Add other labels values.
StreamBuilder	l(java.util.Map<java.lang.String,java.lang.String> labels) Add other labels values.
StreamBuilder	l(java.lang.String labelName, java.lang.String labelValue) Add a new label and return this object.
StreamBuilder	trace() Sets label level to Labels.TRACE, the same as Labels.VERBOSE.
StreamBuilder	unknown() Sets label level to Labels.UNKNOWN.
StreamBuilder	verbose() Sets label level to Labels.VERBOSE.
StreamBuilder	warning() Sets label level to Labels.WARN.

Methods inherited from class java.lang.Object

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

Constructor Detail

StreamBuilder

public StreamBuilder(LogController logController)

Method Detail

build

public ILogStream build()

Create stream with previously defined labels.

Returns:

New ILogStream instance.

getLabels

public Labels getLabels()

Provides access to internal Labels object.

Returns:

Internal Labels object.

l

public StreamBuilder l(java.lang.String labelName,
                       java.lang.String labelValue)

Add a new label and return this object.

Parameters:

labelName - Label name. Valid label identifier starts with letter and contains only letters, digits or '_'.

labelValue - Label value. Valid label identifier starts with letter and contains only letters, digits or '_'.

Returns:

This object with added label.

Throws:

java.lang.RuntimeException - when given labelName or labelValue is null or empty.

Since:

0.3.2

l

public StreamBuilder l(Labels labels)

Add other labels values. New values will override existing values, when label names (keys) are equal.

Parameters:

labels - any Labels.

Returns:

This reference.

Since:

0.3.2

l

public StreamBuilder l(java.util.Map<java.lang.String,java.lang.String> labels)

Add other labels values. New values will override existing values, when label names (keys) are equal.

Parameters:

labels - Map with label's name-value mappings.

Returns:

This reference.

Since:

0.3.2

critical

public StreamBuilder critical()

Sets label level to Labels.FATAL, the same as fatal().

Only one level may be assigned to single log stream. Setting other level will override previous value.

Returns:

This reference.

Since:

0.3.2

See Also:

Labels.LEVEL, Labels.FATAL

fatal

public StreamBuilder fatal()

Sets label level to Labels.FATAL.

Only one level may be assigned to single log stream. Setting other level will override previous value.

Returns:

This reference.

Since:

0.3.2

See Also:

Labels.LEVEL, Labels.FATAL

warning

public StreamBuilder warning()

Sets label level to Labels.WARN.

Only one level may be assigned to single log stream. Setting other level will override previous value.

Returns:

This reference.

Since:

0.3.2

See Also:

Labels.LEVEL, Labels.WARN

info

public StreamBuilder info()

Sets label level to Labels.INFO.

Only one level may be assigned to single log stream. Setting other level will override previous value.

Returns:

This reference.

Since:

0.3.2

See Also:

Labels.LEVEL, Labels.INFO

debug

public StreamBuilder debug()

Sets label level to Labels.DEBUG.

Only one level may be assigned to single log stream. Setting other level will override previous value.

Returns:

This reference.

Since:

0.3.2

See Also:

Labels.LEVEL, Labels.DEBUG

verbose

public StreamBuilder verbose()

Sets label level to Labels.VERBOSE.

Only one level may be assigned to single log stream. Setting other level will override previous value.

Returns:

This reference.

Since:

0.3.2

See Also:

Labels.LEVEL, Labels.VERBOSE

trace

public StreamBuilder trace()

Sets label level to Labels.TRACE, the same as Labels.VERBOSE.

Only one level may be assigned to single log stream. Setting other level will override previous value.

Returns:

This reference.

Since:

0.3.2

See Also:

Labels.LEVEL, Labels.TRACE, Labels.VERBOSE

unknown

public StreamBuilder unknown()

Sets label level to Labels.UNKNOWN.

Only one level may be assigned to single log stream. Setting other level will override previous value.

Returns:

This reference.

Since:

0.3.2

See Also:

Labels.LEVEL, Labels.UNKNOWN