Class LoggersEndpoint

java.lang.Object

io.micronaut.management.endpoint.loggers.LoggersEndpoint

@Endpoint(id="loggers",
          defaultSensitive=false,
          defaultEnabled=false)
public class LoggersEndpoint
extends Object

Exposes an Endpoint to manage loggers.

Since:

1.0

Author:

Matthew Moss

Field Summary

Fields

Modifier and Type	Field	Description
static final boolean	DEFAULT_ENABLED	Endpoint default enabled.
static final boolean	DEFAULT_SENSITIVE	Endpoint default sensitivity.
static final String	NAME	Endpoint name.
static final String	PREFIX	Endpoint configuration prefix.

Constructor Summary

Constructors

Constructor	Description
LoggersEndpoint(ManagedLoggingSystem loggingSystem, LoggersManager<Map<String,Object>> loggersManager)

Method Summary

Modifier and Type	Method	Description
boolean	isWriteSensitive()
Publisher<Map<String,Object>>	logger(@NotBlank String name)
Publisher<Map<String,Object>>	loggers()
void	setLogLevel(@NotBlank String name, @Nullable LogLevel configuredLevel)
void	setWriteSensitive(boolean writeSensitive)	Determines whether modifications to the log level should require authentication.

Methods inherited from class Object

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

Field Details

NAME

public static final String NAME

Endpoint name.

See Also:

• Constant Field Values

PREFIX

public static final String PREFIX

Endpoint configuration prefix.

See Also:

• Constant Field Values

DEFAULT_ENABLED

public static final boolean DEFAULT_ENABLED

Endpoint default enabled.

See Also:

• Constant Field Values

DEFAULT_SENSITIVE

public static final boolean DEFAULT_SENSITIVE

Endpoint default sensitivity.

See Also:

• Constant Field Values

Constructor Details

LoggersEndpoint

public LoggersEndpoint(ManagedLoggingSystem loggingSystem,
 LoggersManager<Map<String,Object>> loggersManager)

Parameters:

loggingSystem - the LoggingSystem

loggersManager - the LoggersManager

Method Details

loggers

@Read
@SingleResult
public Publisher<Map<String,Object>> loggers()

Returns:

the loggers as a Mono

logger

@Read
@SingleResult
public Publisher<Map<String,Object>> logger(@NotBlank @Selector
 @NotBlank String name)

Parameters:

name - The name of the logger to find

Returns:

the LogLevel (both configured and effective) of the named logger

setLogLevel

@Write
@Sensitive(property="write-sensitive")
public void setLogLevel(@NotBlank @Selector
 @NotBlank String name,
 @Nullable LogLevel configuredLevel)

Parameters:

name - The name of the logger to configure

configuredLevel - The LogLevel to set on the named logger

isWriteSensitive

public boolean isWriteSensitive()

Returns:

True if modifications require authentication

setWriteSensitive

public void setWriteSensitive(boolean writeSensitive)

Determines whether modifications to the log level should require authentication. Default value (true).

Parameters:

writeSensitive - The write sensitivity option.