Module io.jstach.rainbowgum

Package io.jstach.rainbowgum

Interface LogOutputRegistry

All Superinterfaces:

LogOutput.OutputProvider

public sealed interface LogOutputRegistry
extends LogOutput.OutputProvider

Register output providers by URI scheme.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	LIST_OUTPUT_SCHEME	The URI scheme for list provider.
static final String	NAMED_OUTPUT_SCHEME	A meta URI scheme to reference outputs registered somewhere else.

Method Summary

Modifier and Type	Method	Description
List<LogResponse>	flush()	Attempts to flush all outputs usually for log rotation.
Optional<LogOutput>	output(String name)	Finds an output by name.
void	register(String scheme, LogOutput.OutputProvider provider)	Register a provider by scheme.
List<LogResponse>	reopen()	Attempts to reopen all outputs of a certain type usually for log rotation.
List<LogResponse>	status()	Will retrieve the status of all outputs usually for health checking.

Methods inherited from interface io.jstach.rainbowgum.LogOutput.OutputProvider

provide

Field Details

NAMED_OUTPUT_SCHEME

static final String NAMED_OUTPUT_SCHEME

A meta URI scheme to reference outputs registered somewhere else.

See Also:

• Constant Field Values

LIST_OUTPUT_SCHEME

static final String LIST_OUTPUT_SCHEME

The URI scheme for list provider.

See Also:

• Constant Field Values

Method Details

register

void register(String scheme,
 LogOutput.OutputProvider provider)

Register a provider by scheme.

Parameters:

scheme - URI scheme to match for.

provider - provider for scheme.

output

Optional<LogOutput> output(String name)

Finds an output by name.

Parameters:

name - output name.

Returns:

maybe an output.

reopen

List<LogResponse> reopen()

Attempts to reopen all outputs of a certain type usually for log rotation. This call will block if it attempts to reopen. If reopening is already happening an empty list will be returned.

Returns:

the output status of reopened outputs or an empty list if no outputs were reopened.

flush

List<LogResponse> flush()

Attempts to flush all outputs usually for log rotation. This call will block if it attempts to flush. If flush is already happening an empty list will be returned.

Returns:

the output status of reopened outputs or an empty list if no outputs were reopened.

status

List<LogResponse> status()

Will retrieve the status of all outputs usually for health checking.

Returns:

list of status of outputs.