001/*
002 * Licensed to the Apache Software Foundation (ASF) under one or more
003 * contributor license agreements. See the NOTICE file distributed with
004 * this work for additional information regarding copyright ownership.
005 * The ASF licenses this file to You under the Apache license, Version 2.0
006 * (the "License"); you may not use this file except in compliance with
007 * the License. You may obtain a copy of the License at
008 *
009 *      http://www.apache.org/licenses/LICENSE-2.0
010 *
011 * Unless required by applicable law or agreed to in writing, software
012 * distributed under the License is distributed on an "AS IS" BASIS,
013 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
014 * See the license for the specific language governing permissions and
015 * limitations under the license.
016 */
017package org.apache.logging.log4j.core.pattern;
018
019import java.lang.management.ManagementFactory;
020
021import org.apache.logging.log4j.core.LogEvent;
022import org.apache.logging.log4j.core.config.plugins.Plugin;
023import org.apache.logging.log4j.util.PerformanceSensitive;
024
025/**
026 * Returns the relative time in milliseconds since JVM Startup.
027 */
028@Plugin(name = "RelativeTimePatternConverter", category = PatternConverter.CATEGORY)
029@ConverterKeys({ "r", "relative" })
030@PerformanceSensitive("allocation")
031public class RelativeTimePatternConverter extends LogEventPatternConverter {
032    private final long startTime = ManagementFactory.getRuntimeMXBean().getStartTime();
033
034    /**
035     * Private constructor.
036     */
037    public RelativeTimePatternConverter() {
038        super("Time", "time");
039    }
040
041    /**
042     * Obtains an instance of RelativeTimePatternConverter.
043     *
044     * @param options options, currently ignored, may be null.
045     * @return instance of RelativeTimePatternConverter.
046     */
047    public static RelativeTimePatternConverter newInstance(final String[] options) {
048        return new RelativeTimePatternConverter();
049    }
050
051    /**
052     * {@inheritDoc}
053     */
054    @Override
055    public void format(final LogEvent event, final StringBuilder toAppendTo) {
056        final long timestamp = event.getTimeMillis();
057        toAppendTo.append(timestamp - startTime);
058    }
059}