2 * Copyright (c) 2013 Cisco Systems, Inc. and others. All rights reserved.
4 * This program and the accompanying materials are made available under the
5 * terms of the Eclipse Public License v1.0 which accompanies this distribution,
6 * and is available at http://www.eclipse.org/legal/epl-v10.html
8 package org.opendaylight.controller.config.yang.logback.config;
10 import java.io.Closeable;
11 import java.io.IOException;
12 import java.util.HashMap;
13 import java.util.Iterator;
14 import java.util.List;
18 import org.slf4j.LoggerFactory;
20 import ch.qos.logback.classic.Level;
21 import ch.qos.logback.classic.LoggerContext;
22 import ch.qos.logback.classic.encoder.PatternLayoutEncoder;
23 import ch.qos.logback.classic.filter.ThresholdFilter;
24 import ch.qos.logback.classic.spi.ILoggingEvent;
25 import ch.qos.logback.core.Appender;
26 import ch.qos.logback.core.rolling.FixedWindowRollingPolicy;
27 import ch.qos.logback.core.rolling.SizeBasedTriggeringPolicy;
28 import ch.qos.logback.core.rolling.TimeBasedRollingPolicy;
30 import com.google.common.base.Optional;
31 import com.google.common.base.Preconditions;
32 import com.google.common.collect.Sets;
35 * Implementation of {@link ContextSetter}. Resets running logback
38 public class ContextSetterImpl implements ContextSetter, Closeable {
40 private final LogbackStatusListener statusListener;
41 private static final org.slf4j.Logger classLogger = LoggerFactory.getLogger(ContextSetterImpl.class);
43 public ContextSetterImpl(LogbackRuntimeRegistrator rootRuntimeBeanRegistratorWrapper) {
44 statusListener = new LogbackStatusListener(rootRuntimeBeanRegistratorWrapper);
45 statusListener.register();
48 public void updateContext(LogbackModule module) {
49 LoggerContext context = (LoggerContext) LoggerFactory.getILoggerFactory();
51 List<ch.qos.logback.classic.Logger> loggersBefore = context.getLoggerList();
53 createLoggers(context, module, Sets.newHashSet(loggersBefore));
56 private Map<String, Appender<ILoggingEvent>> createConsoleAppenders(LoggerContext context, LogbackModule module) {
57 Map<String, Appender<ILoggingEvent>> appendersMap = new HashMap<>();
58 for (ConsoleAppenderTO appender : module.getConsoleAppenderTO()) {
59 Preconditions.checkState(appendersMap.containsKey(appender.getName()) == false,
60 "Duplicate appender name %s", appender.getName());
61 ch.qos.logback.core.ConsoleAppender app = new ch.qos.logback.core.ConsoleAppender();
62 app.setContext(context);
63 PatternLayoutEncoder encoder = new PatternLayoutEncoder();
64 encoder.setContext(context);
65 encoder.setPattern(appender.getEncoderPattern());
67 app.setEncoder(encoder);
68 ThresholdFilter filter = new ThresholdFilter();
69 filter.setContext(context);
70 filter.setLevel(appender.getThresholdFilter());
72 app.getCopyOfAttachedFiltersList().add(filter);
73 app.setName(appender.getName());
75 appendersMap.put(app.getName(), app);
80 private void createLoggers(LoggerContext context, LogbackModule module,
81 Set<ch.qos.logback.classic.Logger> loggersBefore) {
83 Map<String, Appender<ILoggingEvent>> appendersMap = getAppenders(module, context);
85 for (LoggerTO logger : module.getLoggerTO()) {
86 classLogger.trace("Setting configuration for logger {}", logger.getLoggerName());
87 final ch.qos.logback.classic.Logger logbackLogger = context.getLogger(logger.getLoggerName());
89 Optional<Set<Appender<ILoggingEvent>>> appendersBefore = getAppendersBefore(loggersBefore, logbackLogger);
90 classLogger.trace("Logger {}: Appenders registered before: {}", logger.getLoggerName(),
91 appendersBefore.isPresent() ? appendersBefore.get() : "NO APPENDERS BEFORE");
93 logbackLogger.setLevel(Level.toLevel(logger.getLevel()));
95 addNewAppenders(appendersMap, logger, logbackLogger, appendersBefore);
96 removeBeforeAppenders(loggersBefore, logger, logbackLogger, appendersBefore);
100 private void addNewAppenders(Map<String, Appender<ILoggingEvent>> appendersMap, LoggerTO logger,
101 ch.qos.logback.classic.Logger logbackLogger, Optional<Set<Appender<ILoggingEvent>>> appendersBefore) {
102 if (logger.getAppenders() != null) {
103 for (String appenderName : logger.getAppenders()) {
104 if (appendersMap.containsKey(appenderName)) {
105 logbackLogger.addAppender(appendersMap.get(appenderName));
106 classLogger.trace("Logger {}: Adding new appender: {}", logger.getLoggerName(), appenderName);
108 throw new IllegalStateException("No appender " + appenderName
109 + " found. This error should have been discovered by validation");
115 private void removeBeforeAppenders(Set<ch.qos.logback.classic.Logger> loggersBefore, LoggerTO logger,
116 ch.qos.logback.classic.Logger logbackLogger, Optional<Set<Appender<ILoggingEvent>>> appendersBefore) {
117 if (appendersBefore.isPresent()) {
118 for (Appender<ILoggingEvent> appenderBefore : appendersBefore.get()) {
119 logbackLogger.detachAppender(appenderBefore);
120 appenderBefore.stop();
121 classLogger.trace("Logger {}: Removing old appender: {}", logger.getLoggerName(),
122 appenderBefore.getName());
124 loggersBefore.remove(logbackLogger);
128 private Optional<Set<Appender<ILoggingEvent>>> getAppendersBefore(Set<ch.qos.logback.classic.Logger> loggersBefore,
129 ch.qos.logback.classic.Logger logbackLogger) {
130 if (loggersBefore.contains(logbackLogger)) {
131 Iterator<Appender<ILoggingEvent>> appenderIt = logbackLogger.iteratorForAppenders();
132 Set<Appender<ILoggingEvent>> appendersBefore = Sets.newHashSet();
133 while (appenderIt.hasNext()) {
134 appendersBefore.add(appenderIt.next());
136 return Optional.of(appendersBefore);
138 return Optional.absent();
142 private Map<String, Appender<ILoggingEvent>> getAppenders(LogbackModule module, LoggerContext context) {
143 Map<String, Appender<ILoggingEvent>> appendersMap = new HashMap<>();
144 addAllAppenders(appendersMap, createRollingAppenders(context, module));
145 addAllAppenders(appendersMap, createFileAppenders(context, module));
146 addAllAppenders(appendersMap, createConsoleAppenders(context, module));
151 private void addAllAppenders(Map<String, Appender<ILoggingEvent>> allAppenders,
152 Map<String, Appender<ILoggingEvent>> appendersToAdd) {
153 for (String appenderName : appendersToAdd.keySet()) {
154 Preconditions.checkState(allAppenders.containsKey(appenderName) == false, "Duplicate appender name %s",
156 allAppenders.put(appenderName, appendersToAdd.get(appenderName));
160 private Map<String, Appender<ILoggingEvent>> createFileAppenders(LoggerContext context, LogbackModule module) {
161 Map<String, Appender<ILoggingEvent>> appendersMap = new HashMap<>();
162 for (FileAppenderTO appender : module.getFileAppenderTO()) {
163 Preconditions.checkState(appendersMap.containsKey(appender.getName()) == false,
164 "Duplicate appender name %s", appender.getName());
165 ch.qos.logback.core.FileAppender app = new ch.qos.logback.core.FileAppender<>();
166 app.setAppend(appender.getAppend());
167 app.setContext(context);
168 PatternLayoutEncoder encoder = new PatternLayoutEncoder();
169 encoder.setContext(context);
170 encoder.setPattern(appender.getEncoderPattern());
172 app.setEncoder(encoder);
173 app.setFile(appender.getFileName());
174 app.setName(appender.getName());
176 appendersMap.put(app.getName(), app);
182 private Map<String, Appender<ILoggingEvent>> createRollingAppenders(LoggerContext context, LogbackModule module) {
183 Map<String, Appender<ILoggingEvent>> appendersMap = new HashMap<>();
184 for (RollingFileAppenderTO appender : module.getRollingFileAppenderTO()) {
185 Preconditions.checkState(appendersMap.containsKey(appender.getName()) == false,
186 "Duplicate appender name %s", appender.getName());
187 ch.qos.logback.core.rolling.RollingFileAppender app = new ch.qos.logback.core.rolling.RollingFileAppender<>();
188 app.setAppend(appender.getAppend());
189 app.setContext(context);
190 PatternLayoutEncoder encoder = new PatternLayoutEncoder();
191 encoder.setContext(context);
192 encoder.setPattern(appender.getEncoderPattern());
194 app.setEncoder(encoder);
195 app.setFile(appender.getFileName());
196 if (appender.getRollingPolicyType().equals("FixedWindowRollingPolicy")) {
197 FixedWindowRollingPolicy policy = new FixedWindowRollingPolicy();
198 policy.setContext(context);
199 policy.setMaxIndex(appender.getMaxIndex());
200 policy.setMinIndex(appender.getMinIndex());
201 policy.setFileNamePattern(appender.getFileNamePattern());
202 policy.setParent(app);
204 app.setRollingPolicy(policy);
205 } else if (appender.getRollingPolicyType().equals("TimeBasedRollingPolicy")) {
206 TimeBasedRollingPolicy policy = new TimeBasedRollingPolicy();
207 policy.setContext(context);
208 policy.setMaxHistory(appender.getMaxHistory());
209 if (appender.getCleanHistoryOnStart() != null) {
210 policy.setCleanHistoryOnStart(appender.getCleanHistoryOnStart());
212 policy.setFileNamePattern(appender.getFileNamePattern());
213 policy.setParent(app);
215 app.setRollingPolicy(policy);
217 SizeBasedTriggeringPolicy triggeringPolicy = new SizeBasedTriggeringPolicy();
218 triggeringPolicy.setContext(context);
219 triggeringPolicy.setMaxFileSize(appender.getMaxFileSize());
220 triggeringPolicy.start();
221 app.setTriggeringPolicy(triggeringPolicy);
222 app.setName(appender.getName());
224 appendersMap.put(app.getName(), app);
230 public void close() throws IOException {
231 statusListener.close();