org.elasticsearch.common.logging

Class LogConfigurator

java.lang.Object

org.elasticsearch.common.logging.LogConfigurator

public class LogConfigurator
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
LogConfigurator()

Method Summary

Modifier and Type	Method and Description
static void	configure(Environment environment) Configure logging reading from any log4j2.properties found in the config directory and its subdirectories from the specified environment.
static void	configureWithoutConfig(Settings settings) Configure logging without reading a log4j2.properties file, effectively configuring the status logger and all loggers to the console.
static void	registerErrorListener() Registers a listener for status logger errors.

Methods inherited from class java.lang.Object

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

Constructor Detail

LogConfigurator

public LogConfigurator()

Method Detail

registerErrorListener

public static void registerErrorListener()

Registers a listener for status logger errors. This listener should be registered as early as possible to ensure that no errors are logged by the status logger before logging is configured.

configureWithoutConfig

public static void configureWithoutConfig(Settings settings)

Configure logging without reading a log4j2.properties file, effectively configuring the status logger and all loggers to the console.

Parameters:

settings - for configuring logger.level and individual loggers

configure

public static void configure(Environment environment)
                      throws java.io.IOException,
                             UserException

Configure logging reading from any log4j2.properties found in the config directory and its subdirectories from the specified environment. Will also configure logging to point the logs directory from the specified environment.

Parameters:

environment - the environment for reading configs and the logs path

Throws:

java.io.IOException - if there is an issue readings any log4j2.properties in the config directory

UserException - if there are no log4j2.properties in the specified configs path