io.micronaut.management.endpoint.loggers

Class LoggersEndpoint

java.lang.Object

io.micronaut.management.endpoint.loggers.LoggersEndpoint

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

Exposes an Endpoint to manage loggers.

Since:

1.0

Author:

Matthew Moss

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor and Description
LoggersEndpoint(ManagedLoggingSystem loggingSystem, LoggersManager<java.util.Map<java.lang.String,java.lang.Object>> loggersManager)

Method Summary

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

Methods inherited from class java.lang.Object

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

Field Detail

NAME

public static final java.lang.String NAME

Endpoint name.

See Also:

Constant Field Values

PREFIX

public static final java.lang.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 Detail

LoggersEndpoint

public LoggersEndpoint(ManagedLoggingSystem loggingSystem,
                       LoggersManager<java.util.Map<java.lang.String,java.lang.Object>> loggersManager)

Parameters:

loggingSystem - the LoggingSystem

loggersManager - the LoggersManager

Method Detail

loggers

@Read
public io.reactivex.Single<java.util.Map<java.lang.String,java.lang.Object>> loggers()

Returns:

the loggers as a Single

logger

@Read
public io.reactivex.Single<java.util.Map<java.lang.String,java.lang.Object>> logger(@NotBlank @Selector
                                                                                          @NotBlank java.lang.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 java.lang.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.