TinyLoki.Settings (mjaron-tinyloki-java 0.3.11 API)

java.lang.Object
- pl.mjaron.tinyloki.TinyLoki.Settings

Enclosing class:

TinyLoki
```
public static class TinyLoki.Settings
extends java.lang.Object
```
Configuration used to create a new LogController object.

Since:

0.3.0

Constructor Summary

Constructors
Constructor and Description

Settings(java.lang.String url)
Settings constructor with initial URL value.

Constructors
Constructor and Description
`Settings(java.lang.String url)` Settings constructor with initial URL value.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`LabelSettings`	`getLabelSettings()` Gives `LabelSettings` defined by this library's user.
`ILogCollector`	`getLogCollector()` Getter of `ILogCollector`.
`ILogEncoder`	`getLogEncoder()` Getter of `ILogEncoder`.
`ILogMonitor`	`getLogMonitor()` Getter of `ILogMonitor`.
`ILogSender`	`getLogSender()` Getter of `ILogSender`.
`LogSenderSettings`	`getLogSenderSettings()` Getter of `LogSenderSettings`.
`LogController`	`start()` Creates and starts the `LogController` instance using parameters defined previously by this settings object.
`TinyLoki.Settings`	`withBasicAuth(java.lang.String user, java.lang.String pass)` Sets the HTTP Basic Auth credentials.
`TinyLoki.Settings`	`withConnectTimeout(int connectTimeout)` Sets the timeout of HTTP connection used to send logs to the Grafana Loki server.
`TinyLoki.Settings`	`withErrorLogMonitor()` Allows setting `ErrorLogMonitor` explicitly.
`TinyLoki.Settings`	`withGzipLogEncoder()` Sets the `ILogEncoder` used to encode logs to `GzipLogEncoder`.
`TinyLoki.Settings`	`withLabelLength(int maxLabelNameLength, int maxLabelValueLength)` Allows changing the default limits of length of label name and value.
`TinyLoki.Settings`	`withLogCollector(ILogCollector logCollector)` Allows changing the default `ILogCollector`, which currently is `JsonLogCollector`.
`TinyLoki.Settings`	`withLogEncoder(ILogEncoder logEncoder)` Allows changing the default `ILogEncoder`, which currently is null (no log encoder).
`TinyLoki.Settings`	`withLogMonitor(ILogMonitor logMonitor)` Allows changing the default `ILogMonitor`, which currently is `ErrorLogMonitor`.
`TinyLoki.Settings`	`withLogSender(ILogSender logSender)` Allows changing the default `ILogSender`, which currently is `HttpLogSender`.
`TinyLoki.Settings`	`withoutLogEncoder()` Resets the `ILogEncoder` to no encoder, so logs will not be encoded before sending.
`TinyLoki.Settings`	`withVerboseLogMonitor()` Allows setting `VerboseLogMonitor` explicitly.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - Settings
```
public Settings(java.lang.String url)
```
    Settings constructor with initial URL value.
    
    Parameters:
    
    url - URL to Loki HTTP API endpoint, usually ending with /loki/api/v1/push.
    
    Since:
    
    0.3.0
- Method Detail
  - withBasicAuth
```
public TinyLoki.Settings withBasicAuth(java.lang.String user,
                                       java.lang.String pass)
```
    Sets the HTTP Basic Auth credentials.
    
    Parameters:
    
    user - Username.
    
    pass - Password.
    
    Returns:
    
    This TinyLoki.Settings object reference.
    
    Since:
    
    0.3.0
  - withConnectTimeout
```
public TinyLoki.Settings withConnectTimeout(int connectTimeout)
```
    Sets the timeout of HTTP connection used to send logs to the Grafana Loki server.
    
    Parameters:
    
    connectTimeout - Time in milliseconds.
    
    Returns:
    
    This TinyLoki.Settings object reference.
    
    Since:
    
    0.3.0
  - withLogCollector
```
public TinyLoki.Settings withLogCollector(ILogCollector logCollector)
```
    Allows changing the default ILogCollector, which currently is JsonLogCollector.
    
    Parameters:
    
    logCollector - Instance of custom ILogCollector.
    
    Returns:
    
    This TinyLoki.Settings object reference.
    
    Since:
    
    0.3.0
  - withLogEncoder
```
public TinyLoki.Settings withLogEncoder(ILogEncoder logEncoder)
```
    Allows changing the default ILogEncoder, which currently is null (no log encoder).
    
    Parameters:
    
    logEncoder - Instance of custom ILogEncoder.
    
    Returns:
    
    This TinyLoki.Settings object reference.
    
    Since:
    
    0.3.4
  - withGzipLogEncoder
```
public TinyLoki.Settings withGzipLogEncoder()
```
    Sets the ILogEncoder used to encode logs to GzipLogEncoder.
    
    Returns:
    
    This TinyLoki.Settings object reference.
    
    Since:
    
    0.3.4
  - withoutLogEncoder
```
public TinyLoki.Settings withoutLogEncoder()
```
    Resets the ILogEncoder to no encoder, so logs will not be encoded before sending.
    
    Returns:
    
    This TinyLoki.Settings object reference.
    
    Since:
    
    0.3.4
  - withLogMonitor
```
public TinyLoki.Settings withLogMonitor(ILogMonitor logMonitor)
```
    Allows changing the default ILogMonitor, which currently is ErrorLogMonitor.
    
    Parameters:
    
    logMonitor - Instance of custom ILogMonitor.
    
    Returns:
    
    This TinyLoki.Settings object reference.
    
    Since:
    
    0.3.0
  - withErrorLogMonitor
```
public TinyLoki.Settings withErrorLogMonitor()
```
    Allows setting ErrorLogMonitor explicitly.
    
    Returns:
    
    This TinyLoki.Settings object reference.
    
    Since:
    
    0.3.4
  - withVerboseLogMonitor
```
public TinyLoki.Settings withVerboseLogMonitor()
```
    Allows setting VerboseLogMonitor explicitly.
    
    Returns:
    
    This TinyLoki.Settings object reference.
    
    Since:
    
    0.3.4
  - withLogSender
```
public TinyLoki.Settings withLogSender(ILogSender logSender)
```
    Allows changing the default ILogSender, which currently is HttpLogSender.
    
    Parameters:
    
    logSender - Instance of custom ILogSender.
    
    Returns:
    
    This TinyLoki.Settings object reference.
    
    Since:
    
    0.3.0
  - withLabelLength
```
public TinyLoki.Settings withLabelLength(int maxLabelNameLength,
                                         int maxLabelValueLength)
```
    Allows changing the default limits of length of label name and value.
    
    Parameters:
    
    maxLabelNameLength - Custom value of label name length. Must be positive.
    
    maxLabelValueLength - Custom value of label value length. Must be positive.
    
    Returns:
    
    This TinyLoki.Settings object reference.
    
    Since:
    
    0.3.0
    
    See Also:
    
    LabelSettings, LabelSettings.DEFAULT_MAX_LABEL_NAME_LENGTH, LabelSettings.DEFAULT_MAX_LABEL_VALUE_LENGTH, Labels, Labels.prettify(Labels, int, int)
  - getLogSenderSettings
```
public LogSenderSettings getLogSenderSettings()
```
    Getter of LogSenderSettings. Used by TinyLoki to initialize the HttpLogSender.
    
    Returns:
    
    Reference to LogSenderSettings instance in this settings object.
    
    Since:
    
    0.3.0
  - getLogCollector
```
public ILogCollector getLogCollector()
```
    Getter of ILogCollector. Used by TinyLoki to obtain selected log collector.
    
    Returns:
    
    Selected log collector.
    
    Since:
    
    0.3.0
  - getLogEncoder
```
public ILogEncoder getLogEncoder()
```
    Getter of ILogEncoder.
    
    Returns:
    
    Selected ILogEncoder or null if there is no encoder.
    
    Since:
    
    0.3.4
  - getLogMonitor
```
public ILogMonitor getLogMonitor()
```
    Getter of ILogMonitor. Used by TinyLoki to obtain selected log monitor.
    
    Returns:
    
    Selected log monitor.
    
    Since:
    
    0.3.0
  - getLogSender
```
public ILogSender getLogSender()
```
    Getter of ILogSender. Used by TinyLoki to obtain selected log sender.
    
    Returns:
    
    Selected log sender.
    
    Since:
    
    0.3.0
  - getLabelSettings
```
public LabelSettings getLabelSettings()
```
    Gives LabelSettings defined by this library's user.
    
    Returns:
    
    Selected LabelSettings.
  - start
```
public LogController start()
```
    Creates and starts the LogController instance using parameters defined previously by this settings object.
    
    Returns:
    
    New LogController instance.

Class TinyLoki.Settings

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Settings

Method Detail

withBasicAuth

withConnectTimeout

withLogCollector

withLogEncoder

withGzipLogEncoder

withoutLogEncoder

withLogMonitor

withErrorLogMonitor

withVerboseLogMonitor

withLogSender

withLabelLength

getLogSenderSettings

getLogCollector

getLogEncoder

getLogMonitor

getLogSender

getLabelSettings

start