java/com/google/gerrit/server/util/PluginLogFile.java

// Copyright (C) 2015 The Android Open Source Project
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

package com.google.gerrit.server.util;

import com.google.errorprone.annotations.InlineMe;
import com.google.gerrit.common.Nullable;
import com.google.gerrit.extensions.events.LifecycleListener;
import com.google.gerrit.extensions.systemstatus.ServerInformation;
import com.google.gerrit.server.config.LogConfig;
import org.apache.log4j.Layout;
import org.apache.log4j.LogManager;
import org.apache.log4j.Logger;

public abstract class PluginLogFile implements LifecycleListener {

  private final SystemLog systemLog;
  private final ServerInformation serverInfo;
  private final String logName;
  private final Layout layout;
  private final Layout jsonLayout;
  private final boolean textLogging;
  private final boolean jsonLogging;

  /** Kept for backwards compatibility until all plugins have been updated. */
  @Deprecated
  @InlineMe(replacement = "this(systemLog, serverInfo, logName, layout, null, true, false)")
  public PluginLogFile(
      SystemLog systemLog, ServerInformation serverInfo, String logName, Layout layout) {
    this(systemLog, serverInfo, logName, layout, null, true, false);
  }

  public PluginLogFile(
      SystemLog systemLog,
      ServerInformation serverInfo,
      String logName,
      Layout layout,
      @Nullable Layout jsonLayout,
      LogConfig config) {
    this(
        systemLog,
        serverInfo,
        logName,
        layout,
        jsonLayout,
        config.isTextLogging(),
        config.isJsonLogging());
  }

  public PluginLogFile(
      SystemLog systemLog,
      ServerInformation serverInfo,
      String logName,
      Layout layout,
      @Nullable Layout jsonLayout,
      boolean textLogging,
      boolean jsonLogging) {
    this.systemLog = systemLog;
    this.serverInfo = serverInfo;
    this.logName = logName;
    this.layout = layout;
    this.jsonLayout = jsonLayout;
    this.textLogging = textLogging;
    this.jsonLogging = jsonLogging && jsonLayout != null;
  }

  @Override
  public void start() {
    if (textLogging) {
      initLogger(logName, layout);
    }
    if (jsonLogging) {
      initLogger(logName, ".json", jsonLayout);
    }
  }

  @Override
  public void stop() {
    // stop is called when plugin is unloaded or when the server shutdown.
    // Only clean up when the server is shutting down to prevent issue when a
    // plugin is reloaded. The issue is that gerrit load the new plugin and then
    // unload the old one so because loggers are static, the unload of the old
    // plugin would remove the appenders just created by the new plugin.
    if (serverInfo.getState() == ServerInformation.State.SHUTDOWN) {
      LogManager.getLogger(logName).removeAllAppenders();
    }
  }

  private void initLogger(String logName, Layout layout) {
    initLogger(logName, "", layout);
  }

  private void initLogger(String logName, String logFileExtension, Layout layout) {
    Logger logger = LogManager.getLogger(logName);
    String appenderName = logName + logFileExtension;
    if (logger.getAppender(appenderName) == null) {
      synchronized (systemLog) {
        if (logger.getAppender(appenderName) == null) {
          logger.addAppender(systemLog.createAsyncAppender(appenderName, layout, true, true));
        }
      }
    }
    logger.setAdditivity(false);
  }
}