Module io.helidon.webserver.observe.log

Package io.helidon.webserver.observe.log

Interface LogStreamConfig

All Superinterfaces:

Prototype.Api

All Known Implementing Classes:

LogStreamConfig.BuilderBase.LogStreamConfigImpl

public interface LogStreamConfig
extends Prototype.Api

Log stream configuration for Log Observer.

See Also:

• builder()
• create()

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	LogStreamConfig.Builder	Fluent API builder for LogStreamConfig.
static class	LogStreamConfig.BuilderBase<BUILDER extends LogStreamConfig.BuilderBase<BUILDER,PROTOTYPE>,PROTOTYPE extends LogStreamConfig>	Fluent API builder base for LogStreamConfig.

Method Summary

Modifier and Type	Method	Description
static LogStreamConfig.Builder	builder()	Create a new fluent API builder to customize configuration.
static LogStreamConfig.Builder	builder(LogStreamConfig instance)	Create a new fluent API builder from an existing instance.
HttpMediaType	contentType()
static LogStreamConfig	create()	Create a new instance with default values.
static LogStreamConfig	create(Config config)	Create a new instance from configuration.
boolean	enabled()	Whether stream is enabled.
Duration	idleMessageTimeout()	How long to wait before we send the idle message, to make sure we keep the stream alive.
String	idleString()	String sent when there are no log messages within the idleMessageTimeout().
int	queueSize()	Length of the in-memory queue that buffers log messages from loggers before sending them over the network.

Method Details

builder

static LogStreamConfig.Builder builder()

Create a new fluent API builder to customize configuration.

Returns:

a new builder

builder

static LogStreamConfig.Builder builder(LogStreamConfig instance)

Create a new fluent API builder from an existing instance.

Parameters:

instance - an existing instance used as a base for the builder

Returns:

a builder based on an instance

create

static LogStreamConfig create(Config config)

Create a new instance from configuration.

Parameters:

config - used to configure the new instance

Returns:

a new instance configured from configuration

create

static LogStreamConfig create()

Create a new instance with default values.

Returns:

a new instance

enabled

boolean enabled()

Whether stream is enabled.

Returns:

whether to allow streaming of log statements

contentType

HttpMediaType contentType()

idleMessageTimeout

Duration idleMessageTimeout()

How long to wait before we send the idle message, to make sure we keep the stream alive.

Returns:

if no messages appear within this duration, and idle message will be sent

See Also:

• idleString()

queueSize

int queueSize()

Length of the in-memory queue that buffers log messages from loggers before sending them over the network. If the messages are produced faster than we can send them to client, excess messages are DISCARDED, and will not be sent.

Returns:

size of the in-memory queue for log messages

idleString

String idleString()

String sent when there are no log messages within the idleMessageTimeout().

Returns:

string to write over the network when no log messages are received