common/src/main/java/org/openecomp/mso/logger/MsoLoggingServlet.java

   1 /*-
   2  * ============LICENSE_START=======================================================
   3  * ONAP - SO
   4  * ================================================================================
   5  * Copyright (C) 2017 AT&T Intellectual Property. All rights reserved.
   6  * ================================================================================
   7  * Licensed under the Apache License, Version 2.0 (the "License");
   8  * you may not use this file except in compliance with the License.
   9  * You may obtain a copy of the License at
  10  *
  11  *      http://www.apache.org/licenses/LICENSE-2.0
  12  *
  13  * Unless required by applicable law or agreed to in writing, software
  14  * distributed under the License is distributed on an "AS IS" BASIS,
  15  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  16  * See the License for the specific language governing permissions and
  17  * limitations under the License.
  18  * ============LICENSE_END=========================================================
  19  */
  20
  21 package org.openecomp.mso.logger;
  22
  23
  24 import java.util.List;
  25
  26 import javax.ws.rs.DefaultValue;
  27 import javax.ws.rs.GET;
  28 import javax.ws.rs.Path;
  29 import javax.ws.rs.PathParam;
  30 import javax.ws.rs.Produces;
  31 import javax.ws.rs.QueryParam;
  32 import javax.ws.rs.core.Response;
  33
  34 import org.slf4j.LoggerFactory;
  35
  36 import ch.qos.logback.classic.Level;
  37 import ch.qos.logback.classic.Logger;
  38 import ch.qos.logback.classic.LoggerContext;
  39 import ch.qos.logback.classic.joran.JoranConfigurator;
  40 import ch.qos.logback.core.Appender;
  41
  42 import com.wordnik.swagger.annotations.Api;
  43 import com.wordnik.swagger.annotations.ApiOperation;
  44
  45 @Path("/logging")
  46 @Api(value="/logging",description="logging")
  47 public class MsoLoggingServlet {
  48
  49     private static final String DEBUGLOG = "asyncEELFDebug";
  50     private MsoLogger logger = MsoLogger.getMsoLogger (MsoLogger.Catalog.GENERAL);
  51     private static final String GENERAL_LOGGER = "com.att.eelf.error";
  52     private static final String AUDIT_LOGGER = "com.att.eelf.audit";
  53     private static final String METRICS_LOGGER = "com.att.eelf.metrics";
  54
  55     @GET
  56     @Path("/setLevel/{logContext}/{level}")
  57     @Produces("text/plain")
  58     @ApiOperation(value="message print",response=Response.class)
  59     public Response setLogLevel (@PathParam("logContext") String logContext, @PathParam("level") String level) {
  60         logger.info (MessageEnum.LOGGER_SETUP, "", "");
  61
  62         LoggerContext context = (LoggerContext) LoggerFactory.getILoggerFactory();
  63                 JoranConfigurator jc = new JoranConfigurator();
  64                 jc.setContext(context);
  65                 Logger updateLogger = context.getLogger (logContext);
  66
  67         if (updateLogger == null) {
  68             logger.info (MessageEnum.LOGGER_NOT_FOUND, logContext, "", "");
  69             String response = "Unknown logger: " + logContext;
  70             return Response.status (200).entity (response).build ();
  71         }
  72
  73         Level currentLevel = updateLogger.getLevel();
  74         if (!currentLevel.equals(Level.toLevel(level))) {
  75                 Level newLevel = Level.toLevel (level);
  76                 updateLogger.setLevel (newLevel);
  77             logger.info (MessageEnum.LOGGER_UPDATE_SUC, updateLogger.getName (), currentLevel.toString(), newLevel.toString());
  78         }
  79
  80         String response = "Log level set to: " + level + " for " + updateLogger.getName ();
  81         return Response.status (200).entity (response).build ();
  82
  83     }
  84
  85     @GET
  86     @Path("/loggers")
  87     @Produces("text/plain")
  88     @SuppressWarnings("rawtypes")
  89     @ApiOperation(value="message print",response=Response.class)
  90     public Response getLoggers () {
  91         StringBuilder response = new StringBuilder ();
  92         LoggerContext context = (LoggerContext) LoggerFactory.getILoggerFactory();
  93                 JoranConfigurator jc = new JoranConfigurator();
  94                 jc.setContext(context);
  95                 List <Logger> loggerList = context.getLoggerList();
  96         for (Logger logger:loggerList) {
  97                 //if (logger.getLevel() != null) {
  98                         response.append(logger.getName()).append(":").append(logger.getLevel()).append(" (")
  99                     .append(logger.getEffectiveLevel()).append(")\n");
 100                 //}
 101         }
 102         return Response.status (200).entity (response).build ();
 103
 104     }
 105
 106     @GET
 107     @Path("/debug")
 108     @Produces("text/plain")
 109     @ApiOperation(value="message print",response=Response.class)
 110     @SuppressWarnings("rawtypes")
 111     /*
 112      * Debug log is used as a general log to store all the logs events, including events generated by MSO code or by
 113      * components used by MSO.
 114      * This method will only enable/disable the function to store MSO generated events into debug log,
 115      * since those events will also be generated to error, audit, metrics log.
 116      * The events generated by other components will not be affected by this interface.
 117      */
 118     public Response updateDebugAppender (@DefaultValue("true") @QueryParam("enable") Boolean enable) {
 119         String response;
 120
 121                 LoggerContext context = (LoggerContext) LoggerFactory.getILoggerFactory();
 122                 JoranConfigurator jc = new JoranConfigurator();
 123                 jc.setContext(context);
 124                 List <Logger> loggerList = context.getLoggerList();
 125                 Logger rootLogger = context.getLogger("ROOT");
 126         Appender appender = rootLogger.getAppender(DEBUGLOG);
 127
 128         if (null == appender) {
 129                 return Response.status (500).entity ("Not able to found Debug appender. Please verify to make sure the needed logback file is present in the config folder.").build ();
 130         }
 131
 132         if (enable) {
 133             logger.info (MessageEnum.LOGGER_UPDATE_DEBUG, "", "");
 134
 135             for (Logger logger: loggerList) {
 136                 if (isMsoLogger (logger.getName ()) && logger.getAppender (DEBUGLOG) == null && logger.getLevel () != null) {
 137                         logger.addAppender (appender);
 138                         logger.setAdditive(false);
 139                 }
 140             }
 141             logger.info (MessageEnum.LOGGER_UPDATE_DEBUG_SUC, "enabled", "", "");
 142             response = "Debuglog successfully enabled.";
 143         } else {
 144             logger.info (MessageEnum.LOGGER_UPDATE_DEBUG, "", "");
 145             for (Logger logger: loggerList) {
 146                 if (isMsoLogger (logger.getName ())) {
 147                         logger.detachAppender (appender);
 148                 }
 149             }
 150             logger.info (MessageEnum.LOGGER_UPDATE_DEBUG_SUC, "disabled", "", "");
 151             response = "Debuglog successfully disabled.";
 152         }
 153         return Response.status (200).entity (response).build ();
 154
 155
 156     }
 157
 158     private boolean isMsoLogger (String loggerName) {
 159         return loggerName.contains (GENERAL_LOGGER) || loggerName.equals (AUDIT_LOGGER)
 160                || loggerName.equals (METRICS_LOGGER);
 161     }
 162
 163 }