org.apache.hive.http

Class Log4j2ConfiguratorServlet

java.lang.Object

javax.servlet.GenericServlet

javax.servlet.http.HttpServlet

org.apache.hive.http.Log4j2ConfiguratorServlet

All Implemented Interfaces:

Serializable, javax.servlet.Servlet, javax.servlet.ServletConfig

public class Log4j2ConfiguratorServlet
extends javax.servlet.http.HttpServlet

A servlet to configure log4j2.
HTTP GET returns all loggers and it's log level in JSON formatted response.
HTTP POST is used for configuring the loggers. POST data should be in the same format as GET's response. To configure (add/update existing loggers), use HTTP POST with logger names and level in the following JSON format.

 {
  "loggers": [ {
    "logger" : "",
    "level" : "INFO"
  }, {
    "logger" : "LlapIoOrc",
    "level" : "WARN"
  }, {
    "logger" : "org.apache.zookeeper.server.NIOServerCnxn",
    "level" : "WARN"
  }]
 }
 

Example usage:

• Returns all loggers with levels in JSON format:

        curl http://hostame:port/conflog
      

• Set root logger to INFO:

        curl -v -H "Content-Type: application/json" -X POST -d '{ "loggers" : [ { "logger" : "", "level" : "INFO" } ] }'
        http://hostame:port/conflog
      

• Set logger with level:

        curl -v -H "Content-Type: application/json" -X POST -d '{ "loggers" : [
        { "logger" : "LlapIoOrc", "level" : "INFO" } ] }' http://hostame:port/conflog
      

• Set log level for all classes under a package:

        curl -v -H "Content-Type: application/json" -X POST -d '{ "loggers" : [
        { "logger" : "org.apache.orc", "level" : "INFO" } ] }' http://hostame:port/conflog
      

• Set log levels for multiple loggers:

        curl -v -H "Content-Type: application/json" -X POST -d '{ "loggers" : [ { "logger" : "", "level" : "INFO" },
        { "logger" : "LlapIoOrc", "level" : "WARN" },
        { "logger" : "org.apache.hadoop.hive.llap.daemon.impl.LlapDaemon", "level" : "INFO" },
        { "logger" : "org.apache.orc", "level" : "INFO" } ] }' http://hostame:port/conflog
      

Response Status Codes:

• 200 - OK : If the POST data is valid and if the request succeeds or if GET request succeeds.
• 401 - UNAUTHORIZED : If the user does not have privileges to access instrumentation servlets. Refer hadoop.security.instrumentation.requires.admin config for more info.
• 400 - BAD_REQUEST : If the POST data is not a valid JSON.
• 500 - INTERNAL_SERVER_ERROR : If GET requests throws any IOException during JSON output generation.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
Log4j2ConfiguratorServlet()

Method Summary

Modifier and Type	Method and Description
void	doGet(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
protected void	doPost(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
void	init() Initialize this servlet.

Methods inherited from class javax.servlet.http.HttpServlet

doDelete, doHead, doOptions, doPut, doTrace, getLastModified, service, service

Methods inherited from class javax.servlet.GenericServlet

destroy, getInitParameter, getInitParameterNames, getServletConfig, getServletContext, getServletInfo, getServletName, init, log, log

Methods inherited from class java.lang.Object

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

Constructor Detail

Log4j2ConfiguratorServlet

public Log4j2ConfiguratorServlet()

Method Detail

init

public void init()
          throws javax.servlet.ServletException

Initialize this servlet.

Overrides:

init in class javax.servlet.GenericServlet

Throws:

javax.servlet.ServletException

doGet

public void doGet(javax.servlet.http.HttpServletRequest request,
                  javax.servlet.http.HttpServletResponse response)
           throws javax.servlet.ServletException,
                  IOException

Overrides:

doGet in class javax.servlet.http.HttpServlet

Throws:

javax.servlet.ServletException

IOException

doPost

protected void doPost(javax.servlet.http.HttpServletRequest request,
                      javax.servlet.http.HttpServletResponse response)
               throws javax.servlet.ServletException,
                      IOException

Overrides:

doPost in class javax.servlet.http.HttpServlet

Throws:

javax.servlet.ServletException

IOException