pl.mjaron.tinyloki

Class TinyLoki

java.lang.Object

pl.mjaron.tinyloki.TinyLoki

public class TinyLoki
extends java.lang.Object

Top-level class which allows initializing the logging system.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TinyLoki.Settings Configuration used to create a new LogController object.

Constructor Summary

Constructors

Constructor and Description
TinyLoki()

Method Summary

Modifier and Type	Method and Description
static LogController	createAndStart(java.lang.String url, java.lang.String user, java.lang.String pass) Deprecated. Use withUrl(String) to initialize settings and finally call TinyLoki.Settings.start(), e.g: TinyLoki.withUrl(url).withBasicAuth(user, pass).start();
static LogController	createAndStart(java.lang.String url, java.lang.String user, java.lang.String pass, ILogCollector logCollector, ILogMonitor logMonitor) Deprecated. Use withUrl(String) to initialize settings and finally call TinyLoki.Settings.start(), e.g: TinyLoki.withUrl(url) .withBasicAuth(user, pass) .withLogCollector(logCollector) .withLogMonitor(logMonitor) .start();
static LogController	createAndStart(java.lang.String url, java.lang.String user, java.lang.String pass, int connectTimeout) Deprecated. Use withUrl(String) to initialize settings and finally call TinyLoki.Settings.start(), e.g: TinyLoki.withUrl(url) .withBasicAuth(user, pass) .withConnectTimeout(connectTimeout) .start();
static LogController	createAndStart(java.lang.String url, java.lang.String user, java.lang.String pass, int connectTimeout, ILogCollector logCollector, ILogMonitor logMonitor) Deprecated. Use withUrl(String) to initialize settings and finally call TinyLoki.Settings.start(), e.g: TinyLoki.withUrl(url) .withBasicAuth(user, pass) .withConnectTimeout(connectTimeout) .withLogCollector(logCollector) .withLogMonitor(logMonitor) .start();
static LogController	createAndStart(TinyLoki.Settings settings) Creates a new LogController with given TinyLoki.Settings.
static Labels	critical() Creates new Labels with label level set to Labels.FATAL.
static Labels	debug() Creates new Labels with label level set to Labels.DEBUG.
static Labels	fatal() Creates new Labels with label level set to Labels.FATAL.
static Labels	info() Creates new Labels with label level set to Labels.INFO.
static Labels	l(Labels other) Create a deep copy of given labels.
static Labels	l(java.util.Map<java.lang.String,java.lang.String> map) Create labels from mapping.
static Labels	l(java.lang.String labelName, java.lang.String labelValue) Initialize a Labels with predefined first label name-value.
static Labels	trace() Creates new Labels with label level set to Labels.TRACE.
static Labels	unknown() Creates new Labels with label level set to Labels.UNKNOWN.
static Labels	verbose() Creates new Labels with label level set to Labels.VERBOSE.
static Labels	warning() Creates new Labels with label level set to Labels.WARN.
static TinyLoki.Settings	withUrl(java.lang.String url) Creates a new TinyLoki.Settings object which is used to initialize a new LogController instance, e.g:

Methods inherited from class java.lang.Object

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

Constructor Detail

TinyLoki

public TinyLoki()

Method Detail

withUrl

public static TinyLoki.Settings withUrl(java.lang.String url)

Creates a new TinyLoki.Settings object which is used to initialize a new LogController instance, e.g:

     LogController logController =
         TinyLoki.withUrl(url)    // Settings created here.
             .withBasicAuth(user, pass)
             .withConnectTimeout(connectTimeout)
             .withLogCollector(logCollector)
             .withLogMonitor(logMonitor)
             .start();            // LogController created here.
 

Parameters:

url - URL to Loki HTTP API endpoint, usually ending with /loki/api/v1/push.

Returns:

New instance of TinyLoki.Settings object, initialized with given url.

createAndStart

public static LogController createAndStart(TinyLoki.Settings settings)

Creates a new LogController with given TinyLoki.Settings.

Parameters:

settings - Configuration of a newly created LogController.

Returns:

New instance of LogController.

Since:

0.3.0

createAndStart

public static LogController createAndStart(java.lang.String url,
                                           java.lang.String user,
                                           java.lang.String pass)

Deprecated. Use withUrl(String) to initialize settings and finally call TinyLoki.Settings.start(), e.g:

     TinyLoki.withUrl(url).withBasicAuth(user, pass).start();
 

Creates a basic configuration of LogController.

Parameters:

url - URL to Loki HTTP API endpoint, usually ending with /loki/api/v1/push.

user - Basic authentication user. If null, BA header will not be sent.

pass - Basic authentication password. If null, BA header will not be sent.

Returns:

New LogController object.

createAndStart

public static LogController createAndStart(java.lang.String url,
                                           java.lang.String user,
                                           java.lang.String pass,
                                           int connectTimeout)

Deprecated. Use withUrl(String) to initialize settings and finally call TinyLoki.Settings.start(), e.g:

     TinyLoki.withUrl(url)
         .withBasicAuth(user, pass)
         .withConnectTimeout(connectTimeout)
         .start();
 

Creates a basic configuration of LogController.

Parameters:

url - URL to Loki HTTP API endpoint, usually ending with /loki/api/v1/push.

user - Basic authentication user. If null, BA header will not be sent.

pass - Basic authentication password. If null, BA header will not be sent.

connectTimeout - HTTP log server connection timeout in milliseconds.

Returns:

New LogController object.

createAndStart

public static LogController createAndStart(java.lang.String url,
                                           java.lang.String user,
                                           java.lang.String pass,
                                           ILogCollector logCollector,
                                           ILogMonitor logMonitor)

Deprecated. Use withUrl(String) to initialize settings and finally call TinyLoki.Settings.start(), e.g:

     TinyLoki.withUrl(url)
         .withBasicAuth(user, pass)
         .withLogCollector(logCollector)
         .withLogMonitor(logMonitor)
         .start();
 

Creates a configuration of LogController.

Parameters:

url - URL to Loki HTTP API endpoint, usually ending with /loki/api/v1/push.

user - Basic authentication user. If null, BA header will not be sent.

pass - Basic authentication password. If null, BA header will not be sent.

logCollector - ILogCollector instance.

logMonitor - ILogMonitor instance.

Returns:

New LogController object.

createAndStart

public static LogController createAndStart(java.lang.String url,
                                           java.lang.String user,
                                           java.lang.String pass,
                                           int connectTimeout,
                                           ILogCollector logCollector,
                                           ILogMonitor logMonitor)

Deprecated. Use withUrl(String) to initialize settings and finally call TinyLoki.Settings.start(), e.g:

     TinyLoki.withUrl(url)
         .withBasicAuth(user, pass)
         .withConnectTimeout(connectTimeout)
         .withLogCollector(logCollector)
         .withLogMonitor(logMonitor)
         .start();
 

Creates a configuration of LogController.

Parameters:

url - URL to Loki HTTP API endpoint, usually ending with /loki/api/v1/push.

user - Basic authentication user. If null, BA header will not be sent.

pass - Basic authentication password. If null, BA header will not be sent.

connectTimeout - HTTP log server connection timeout in milliseconds.

logCollector - ILogCollector instance.

logMonitor - ILogMonitor instance.

Returns:

New LogController object.

Since:

0.2.1

l

public static Labels l(java.lang.String labelName,
                       java.lang.String labelValue)

Initialize a Labels with predefined first label name-value. Use Labels.l() to append next values.

Parameters:

labelName - Label name.

labelValue - Label value.

Returns:

New Labels instance initialized with single label.

Since:

0.2.2

l

public static Labels l(java.util.Map<java.lang.String,java.lang.String> map)

Create labels from mapping.

Parameters:

map - Map containing label names and label values.

Returns:

New Labels object initialized with labels stored in map.

Since:

0.2.2

l

public static Labels l(Labels other)

Create a deep copy of given labels.

Parameters:

other - Other labels instance.

Returns:

Deep copy of labels.

Since:

0.2.2

critical

public static Labels critical()

Creates new Labels with label level set 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.2.1

See Also:

Labels.LEVEL, Labels.FATAL

fatal

public static Labels fatal()

Creates new Labels with label level set 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.2.1

See Also:

Labels.LEVEL, Labels.FATAL

warning

public static Labels warning()

Creates new Labels with label level set 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.2.1

See Also:

Labels.LEVEL, Labels.WARN

info

public static Labels info()

Creates new Labels with label level set 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.2.1

See Also:

Labels.LEVEL, Labels.INFO

debug

public static Labels debug()

Creates new Labels with label level set 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.2.1

See Also:

Labels.LEVEL, Labels.DEBUG

verbose

public static Labels verbose()

Creates new Labels with label level set 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.2.1

See Also:

Labels.LEVEL, Labels.VERBOSE

trace

public static Labels trace()

Creates new Labels with label level set to Labels.TRACE.

The same as verbose()

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

Returns:

This reference.

Since:

0.2.1

See Also:

Labels.LEVEL, Labels.TRACE, Labels.VERBOSE

unknown

public static Labels unknown()

Creates new Labels with label level set 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.2.1

See Also:

Labels.LEVEL, Labels.UNKNOWN