org.smallmind.scribe.pen.spring.plan.FileLoggingPlan Maven / Gradle / Ivy

Go to download
/*
 * Copyright (c) 2007 through 2024 David Berkman
 *
 * This file is part of the SmallMind Code Project.
 *
 * The SmallMind Code Project is free software, you can redistribute
 * it and/or modify it under either, at your discretion...
 *
 * 1) The terms of GNU Affero General Public License as published by the
 * Free Software Foundation, either version 3 of the License, or (at
 * your option) any later version.
 *
 * ...or...
 *
 * 2) The terms of the Apache License, Version 2.0.
 *
 * The SmallMind Code Project is distributed in the hope that it will
 * be useful, but WITHOUT ANY WARRANTY; without even the implied warranty
 * of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
 * General Public License or Apache License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * and the Apache License along with the SmallMind Code Project. If not, see
 *  or .
 *
 * Additional permission under the GNU Affero GPL version 3 section 7
 * ------------------------------------------------------------------
 * If you modify this Program, or any covered work, by linking or
 * combining it with other code, such other code is not for that reason
 * alone subject to any of the requirements of the GNU Affero GPL
 * version 3.
 */
package org.smallmind.scribe.pen.spring.plan;

import java.io.IOException;
import java.nio.file.Path;
import java.nio.file.Paths;
import java.text.SimpleDateFormat;
import java.util.concurrent.TimeUnit;
import org.smallmind.nutsnbolts.time.Stint;
import org.smallmind.scribe.pen.Appender;
import org.smallmind.scribe.pen.Cleanup;
import org.smallmind.scribe.pen.ConsoleAppender;
import org.smallmind.scribe.pen.DateFormatTimestamp;
import org.smallmind.scribe.pen.DefaultErrorHandler;
import org.smallmind.scribe.pen.ErrorHandler;
import org.smallmind.scribe.pen.FileAppender;
import org.smallmind.scribe.pen.FileSizeQuantifier;
import org.smallmind.scribe.pen.FileSizeRolloverRule;
import org.smallmind.scribe.pen.Formatter;
import org.smallmind.scribe.pen.LastModifiedCleanupRule;
import org.smallmind.scribe.pen.PatternFormatter;
import org.smallmind.scribe.pen.Rollover;
import org.smallmind.scribe.pen.TimestampQuantifier;
import org.smallmind.scribe.pen.TimestampRolloverRule;

public class FileLoggingPlan extends LoggingPlan {

  private Path logPath = Paths.get("/var/log");
  private DateFormatTimestamp shortTimestamp = new DateFormatTimestamp(new SimpleDateFormat("yyyy-MM-dd"));
  private DateFormatTimestamp fullTimestamp = new DateFormatTimestamp(new SimpleDateFormat("yyyy-MM-dd'T'HH:mm:ss.SSSZ"));
  private TimestampQuantifier rolloverPeriod = TimestampQuantifier.TOP_OF_DAY;
  private long retentionDays = 31;
  private long rolloverMegabyteLimit = 100;

  public void setLogPath (Path logPath) {

    this.logPath = logPath;
  }

  public void setShortTimestamp (DateFormatTimestamp shortTimestamp) {

    this.shortTimestamp = shortTimestamp;
  }

  public void setFullTimestamp (DateFormatTimestamp fullTimestamp) {

    this.fullTimestamp = fullTimestamp;
  }

  public void setRolloverPeriod (TimestampQuantifier rolloverPeriod) {

    this.rolloverPeriod = rolloverPeriod;
  }

  public void setRetentionDays (long retentionDays) {

    this.retentionDays = retentionDays;
  }

  public void setRolloverMegabyteLimit (long rolloverMegabyteLimit) {

    this.rolloverMegabyteLimit = rolloverMegabyteLimit;
  }

  @Override
  public Appender getAppender ()
    throws IOException {

    Formatter patternFormatter;
    Cleanup cleanup;
    Rollover rollover;
    Appender consoleAppender;
    ErrorHandler consoleErrorHandler;

    cleanup = new Cleanup('.', new LastModifiedCleanupRule(new Stint(retentionDays, TimeUnit.DAYS)));
    rollover = new Rollover(shortTimestamp, '.', new TimestampRolloverRule(rolloverPeriod), new FileSizeRolloverRule(rolloverMegabyteLimit, FileSizeQuantifier.MEGABYTES));
    patternFormatter = new PatternFormatter(fullTimestamp, "%d %n %+5l (%.1C.%M:%L) [%T] - %m%!+\n\t!p%!+\n\t!s");

    consoleAppender = new ConsoleAppender(patternFormatter);
    consoleErrorHandler = new DefaultErrorHandler(consoleAppender);

    return new FileAppender(logPath, rollover, cleanup, patternFormatter, consoleErrorHandler);
  }
}