Package com.github.loki4j.client.http

Class HttpConfig

java.lang.Object

com.github.loki4j.client.http.HttpConfig

public class HttpConfig
extends java.lang.Object

Configuration properties for HTTP senders.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	HttpConfig.ApacheHttpConfig
static class	HttpConfig.Builder
static interface	HttpConfig.ClientSpecificConfig
static class	HttpConfig.JavaHttpConfig

Field Summary

Fields

Modifier and Type	Field	Description
HttpConfig.ClientSpecificConfig	clientSpecific	A configuration specific to a certain HTTP client
long	connectionTimeoutMs	Time in milliseconds to wait for HTTP connection to Loki to be established before reporting an error
java.lang.String	contentType	Content-type header to send to Loki
java.util.Optional<java.lang.String>	password	Password to use for basic auth
java.lang.String	pushUrl	Loki endpoint to be used for sending batches
long	requestTimeoutMs	Time in milliseconds to wait for HTTP request to Loki to be responded before reporting an error
java.util.Optional<java.lang.String>	tenantId	Tenant identifier.
java.util.Optional<java.lang.String>	username	Username to use for basic auth

Constructor Summary

Constructors

Constructor	Description
HttpConfig(java.lang.String pushUrl, long connectionTimeoutMs, long requestTimeoutMs, java.util.Optional<java.lang.String> tenantId, java.lang.String contentType, java.util.Optional<java.lang.String> username, java.util.Optional<java.lang.String> password, HttpConfig.ClientSpecificConfig clientSpecific)

Method Summary

Modifier and Type	Method	Description
HttpConfig.ApacheHttpConfig	apache()	A shortcut to preferences specific for ApacheHttpConfig
java.util.Optional<java.lang.String>	basicAuthToken()	Token to pass to HTTP server if basic auth is enabled
static HttpConfig.Builder	builder()
HttpConfig.JavaHttpConfig	java()	A shortcut to preferences specific for ApacheHttpConfig

Methods inherited from class java.lang.Object

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

Field Detail

pushUrl

public final java.lang.String pushUrl

Loki endpoint to be used for sending batches

connectionTimeoutMs

public final long connectionTimeoutMs

Time in milliseconds to wait for HTTP connection to Loki to be established before reporting an error

requestTimeoutMs

public final long requestTimeoutMs

Time in milliseconds to wait for HTTP request to Loki to be responded before reporting an error

tenantId

public final java.util.Optional<java.lang.String> tenantId

Tenant identifier. It is required only for sending logs directly to Loki operating in multi-tenant mode. Otherwise this setting has no effect

contentType

public final java.lang.String contentType

Content-type header to send to Loki

username

public final java.util.Optional<java.lang.String> username

Username to use for basic auth

password

public final java.util.Optional<java.lang.String> password

Password to use for basic auth

clientSpecific

public final HttpConfig.ClientSpecificConfig clientSpecific

A configuration specific to a certain HTTP client

Constructor Detail

HttpConfig

public HttpConfig(java.lang.String pushUrl,
                  long connectionTimeoutMs,
                  long requestTimeoutMs,
                  java.util.Optional<java.lang.String> tenantId,
                  java.lang.String contentType,
                  java.util.Optional<java.lang.String> username,
                  java.util.Optional<java.lang.String> password,
                  HttpConfig.ClientSpecificConfig clientSpecific)

Method Detail

basicAuthToken

public final java.util.Optional<java.lang.String> basicAuthToken()

Token to pass to HTTP server if basic auth is enabled

apache

public final HttpConfig.ApacheHttpConfig apache()

A shortcut to preferences specific for ApacheHttpConfig

java

public final HttpConfig.JavaHttpConfig java()

A shortcut to preferences specific for ApacheHttpConfig

builder

public static HttpConfig.Builder builder()