2 * ============LICENSE_START=======================================================
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
11 * http://www.apache.org/licenses/LICENSE-2.0
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=========================================================
21 package org.openecomp.mso.logger;
24 import java.util.List;
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;
34 import org.slf4j.LoggerFactory;
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;
42 import com.wordnik.swagger.annotations.Api;
43 import com.wordnik.swagger.annotations.ApiOperation;
46 @Api(value="/logging",description="logging")
47 public class MsoLoggingServlet {
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";
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, "", "");
62 LoggerContext context = (LoggerContext) LoggerFactory.getILoggerFactory();
63 JoranConfigurator jc = new JoranConfigurator();
64 jc.setContext(context);
65 Logger updateLogger = context.getLogger (logContext);
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 ();
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());
80 String response = "Log level set to: " + level + " for " + updateLogger.getName ();
81 return Response.status (200).entity (response).build ();
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 () + ":" + logger.getLevel () + " (" + logger.getEffectiveLevel () + ")\n");
101 return Response.status (200).entity (response).build ();
107 @Produces("text/plain")
108 @ApiOperation(value="message print",response=Response.class)
109 @SuppressWarnings("rawtypes")
111 * Debug log is used as a general log to store all the logs events, including events generated by MSO code or by
112 * components used by MSO.
113 * This method will only enable/disable the function to store MSO generated events into debug log,
114 * since those events will also be generated to error, audit, metrics log.
115 * The events generated by other components will not be affected by this interface.
117 public Response updateDebugAppender (@DefaultValue("true") @QueryParam("enable") Boolean enable) {
120 LoggerContext context = (LoggerContext) LoggerFactory.getILoggerFactory();
121 JoranConfigurator jc = new JoranConfigurator();
122 jc.setContext(context);
123 List <Logger> loggerList = context.getLoggerList();
124 Logger rootLogger = context.getLogger("ROOT");
125 Appender appender = rootLogger.getAppender(DEBUGLOG);
127 if (null == appender) {
128 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 ();
132 logger.info (MessageEnum.LOGGER_UPDATE_DEBUG, "", "");
134 for (Logger logger: loggerList) {
135 if (isMsoLogger (logger.getName ()) && logger.getAppender (DEBUGLOG) == null && logger.getLevel () != null) {
136 logger.addAppender (appender);
137 logger.setAdditive(false);
140 logger.info (MessageEnum.LOGGER_UPDATE_DEBUG_SUC, "enabled", "", "");
141 response = "Debuglog successfully enabled.";
143 logger.info (MessageEnum.LOGGER_UPDATE_DEBUG, "", "");
144 for (Logger logger: loggerList) {
145 if (isMsoLogger (logger.getName ())) {
146 logger.detachAppender (appender);
149 logger.info (MessageEnum.LOGGER_UPDATE_DEBUG_SUC, "disabled", "", "");
150 response = "Debuglog successfully disabled.";
152 return Response.status (200).entity (response).build ();
157 private boolean isMsoLogger (String loggerName) {
158 return loggerName.contains (GENERAL_LOGGER) || loggerName.equals (AUDIT_LOGGER)
159 || loggerName.equals (METRICS_LOGGER);