| /* |
| * Licensed to the Apache Software Foundation (ASF) under one or more |
| * contributor license agreements. See the NOTICE file distributed with |
| * this work for additional information regarding copyright ownership. |
| * The ASF licenses this file to You 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 org.apache.logging.log4j.core.filter; |
| |
| import java.text.ParseException; |
| import java.text.SimpleDateFormat; |
| import java.util.Calendar; |
| import java.util.TimeZone; |
| |
| import org.apache.logging.log4j.Level; |
| import org.apache.logging.log4j.Marker; |
| import org.apache.logging.log4j.core.Filter; |
| import org.apache.logging.log4j.core.LogEvent; |
| import org.apache.logging.log4j.core.Logger; |
| import org.apache.logging.log4j.plugins.Node; |
| import org.apache.logging.log4j.plugins.Plugin; |
| import org.apache.logging.log4j.plugins.PluginAttribute; |
| import org.apache.logging.log4j.plugins.PluginFactory; |
| import org.apache.logging.log4j.core.time.Clock; |
| import org.apache.logging.log4j.core.time.ClockFactory; |
| import org.apache.logging.log4j.message.Message; |
| import org.apache.logging.log4j.util.PerformanceSensitive; |
| |
| /** |
| * Filters events that fall within a specified time period in each day. |
| */ |
| @Plugin(name = "TimeFilter", category = Node.CATEGORY, elementType = Filter.ELEMENT_TYPE, printObject = true) |
| @PerformanceSensitive("allocation") |
| public final class TimeFilter extends AbstractFilter { |
| private static final Clock CLOCK = ClockFactory.getClock(); |
| |
| /** |
| * Length of hour in milliseconds. |
| */ |
| private static final long HOUR_MS = 3600000; |
| |
| /** |
| * Length of minute in milliseconds. |
| */ |
| private static final long MINUTE_MS = 60000; |
| |
| /** |
| * Length of second in milliseconds. |
| */ |
| private static final long SECOND_MS = 1000; |
| |
| /** |
| * Starting offset from midnight in milliseconds. |
| */ |
| private final long start; |
| |
| /** |
| * Ending offset from midnight in milliseconds. |
| */ |
| private final long end; |
| |
| /** |
| * Timezone. |
| */ |
| private final TimeZone timeZone; |
| |
| private long midnightToday; |
| private long midnightTomorrow; |
| |
| |
| private TimeFilter(final long start, final long end, final TimeZone timeZone, final Result onMatch, |
| final Result onMismatch) { |
| super(onMatch, onMismatch); |
| this.start = start; |
| this.end = end; |
| this.timeZone = timeZone; |
| initMidnight(start); |
| } |
| |
| /** |
| * Initializes the midnight boundaries to midnight in the specified time zone. |
| * @param now a time in milliseconds since the epoch, used to pinpoint the current date |
| */ |
| void initMidnight(final long now) { |
| final Calendar calendar = Calendar.getInstance(timeZone); |
| calendar.setTimeInMillis(now); |
| calendar.set(Calendar.HOUR_OF_DAY, 0); |
| calendar.set(Calendar.MINUTE, 0); |
| calendar.set(Calendar.SECOND, 0); |
| calendar.set(Calendar.MILLISECOND, 0); |
| midnightToday = calendar.getTimeInMillis(); |
| |
| calendar.add(Calendar.DATE, 1); |
| midnightTomorrow = calendar.getTimeInMillis(); |
| } |
| |
| /** |
| * Package-protected for tests. |
| * |
| * @param currentTimeMillis the time to compare with the boundaries. May re-initialize the cached midnight |
| * boundary values. |
| * @return the action to perform |
| */ |
| Result filter(final long currentTimeMillis) { |
| if (currentTimeMillis >= midnightTomorrow || currentTimeMillis < midnightToday) { |
| initMidnight(currentTimeMillis); |
| } |
| return currentTimeMillis >= midnightToday + start && currentTimeMillis <= midnightToday + end // |
| ? onMatch // within window |
| : onMismatch; |
| } |
| |
| @Override |
| public Result filter(final LogEvent event) { |
| return filter(event.getTimeMillis()); |
| } |
| |
| private Result filter() { |
| return filter(CLOCK.currentTimeMillis()); |
| } |
| |
| @Override |
| public Result filter(final Logger logger, final Level level, final Marker marker, final Message msg, |
| final Throwable t) { |
| return filter(); |
| } |
| |
| @Override |
| public Result filter(final Logger logger, final Level level, final Marker marker, final Object msg, |
| final Throwable t) { |
| return filter(); |
| } |
| |
| @Override |
| public Result filter(final Logger logger, final Level level, final Marker marker, final String msg, |
| final Object... params) { |
| return filter(); |
| } |
| |
| @Override |
| public Result filter(final Logger logger, final Level level, final Marker marker, final String msg, |
| final Object p0) { |
| return filter(); |
| } |
| |
| @Override |
| public Result filter(final Logger logger, final Level level, final Marker marker, final String msg, |
| final Object p0, final Object p1) { |
| return filter(); |
| } |
| |
| @Override |
| public Result filter(final Logger logger, final Level level, final Marker marker, final String msg, |
| final Object p0, final Object p1, final Object p2) { |
| return filter(); |
| } |
| |
| @Override |
| public Result filter(final Logger logger, final Level level, final Marker marker, final String msg, |
| final Object p0, final Object p1, final Object p2, final Object p3) { |
| return filter(); |
| } |
| |
| @Override |
| public Result filter(final Logger logger, final Level level, final Marker marker, final String msg, |
| final Object p0, final Object p1, final Object p2, final Object p3, final Object p4) { |
| return filter(); |
| } |
| |
| @Override |
| public Result filter(final Logger logger, final Level level, final Marker marker, final String msg, |
| final Object p0, final Object p1, final Object p2, final Object p3, final Object p4, final Object p5) { |
| return filter(); |
| } |
| |
| @Override |
| public Result filter(final Logger logger, final Level level, final Marker marker, final String msg, |
| final Object p0, final Object p1, final Object p2, final Object p3, final Object p4, final Object p5, |
| final Object p6) { |
| return filter(); |
| } |
| |
| @Override |
| public Result filter(final Logger logger, final Level level, final Marker marker, final String msg, |
| final Object p0, final Object p1, final Object p2, final Object p3, final Object p4, final Object p5, |
| final Object p6, final Object p7) { |
| return filter(); |
| } |
| |
| @Override |
| public Result filter(final Logger logger, final Level level, final Marker marker, final String msg, |
| final Object p0, final Object p1, final Object p2, final Object p3, final Object p4, final Object p5, |
| final Object p6, final Object p7, final Object p8) { |
| return filter(); |
| } |
| |
| @Override |
| public Result filter(final Logger logger, final Level level, final Marker marker, final String msg, |
| final Object p0, final Object p1, final Object p2, final Object p3, final Object p4, final Object p5, |
| final Object p6, final Object p7, final Object p8, final Object p9) { |
| return filter(); |
| } |
| |
| @Override |
| public String toString() { |
| final StringBuilder sb = new StringBuilder(); |
| sb.append("start=").append(start); |
| sb.append(", end=").append(end); |
| sb.append(", timezone=").append(timeZone.toString()); |
| return sb.toString(); |
| } |
| |
| /** |
| * Creates a TimeFilter. |
| * @param start The start time. |
| * @param end The end time. |
| * @param tz timezone. |
| * @param match Action to perform if the time matches. |
| * @param mismatch Action to perform if the action does not match. |
| * @return A TimeFilter. |
| */ |
| // TODO Consider refactoring to use AbstractFilter.AbstractFilterBuilder |
| @PluginFactory |
| public static TimeFilter createFilter( |
| @PluginAttribute final String start, |
| @PluginAttribute final String end, |
| @PluginAttribute("timezone") final String tz, |
| @PluginAttribute("onMatch") final Result match, |
| @PluginAttribute("onMismatch") final Result mismatch) { |
| final long s = parseTimestamp(start, 0); |
| final long e = parseTimestamp(end, Long.MAX_VALUE); |
| final TimeZone timeZone = tz == null ? TimeZone.getDefault() : TimeZone.getTimeZone(tz); |
| final Result onMatch = match == null ? Result.NEUTRAL : match; |
| final Result onMismatch = mismatch == null ? Result.DENY : mismatch; |
| return new TimeFilter(s, e, timeZone, onMatch, onMismatch); |
| } |
| |
| private static long parseTimestamp(final String timestamp, final long defaultValue) { |
| if (timestamp == null) { |
| return defaultValue; |
| } |
| final SimpleDateFormat stf = new SimpleDateFormat("HH:mm:ss"); |
| stf.setTimeZone(TimeZone.getTimeZone("UTC")); |
| try { |
| return stf.parse(timestamp).getTime(); |
| } catch (final ParseException e) { |
| LOGGER.warn("Error parsing TimeFilter timestamp value {}", timestamp, e); |
| return defaultValue; |
| } |
| } |
| |
| } |