Package org.opensearch.common.logging

Class LogConfigurator

java.lang.Object
org.opensearch.common.logging.LogConfigurator
public class LogConfigurator extends Object
Configures the logger
Opensearch.internal:

  • Constructor Details

    • LogConfigurator

      public LogConfigurator()

  • Method Details

    • 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 IOException, org.opensearch.cli.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:
      IOException - if there is an issue readings any log4j2.properties in the config directory
      org.opensearch.cli.UserException - if there are no log4j2.properties in the specified configs path

    • setNodeName

      public static void setNodeName(String nodeName)
      Sets the node name. This is called before logging is configured if the node name is set in opensearch.yml. Otherwise it is called as soon as the node id is available.