View Javadoc
1   /*
2    * Licensed to the Apache Software Foundation (ASF) under one or more
3    * contributor license agreements. See the NOTICE file distributed with
4    * this work for additional information regarding copyright ownership.
5    * The ASF licenses this file to You under the Apache license, Version 2.0
6    * (the "License"); you may not use this file except in compliance with
7    * the License. You may obtain a copy of the License at
8    *
9    *      http://www.apache.org/licenses/LICENSE-2.0
10   *
11   * Unless required by applicable law or agreed to in writing, software
12   * distributed under the License is distributed on an "AS IS" BASIS,
13   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14   * See the license for the specific language governing permissions and
15   * limitations under the license.
16   */
17  package org.apache.logging.log4j.core.pattern;
18  
19  import java.lang.management.ManagementFactory;
20  
21  import org.apache.logging.log4j.core.LogEvent;
22  import org.apache.logging.log4j.core.config.plugins.Plugin;
23  import org.apache.logging.log4j.util.PerformanceSensitive;
24  
25  /**
26   * Returns the relative time in milliseconds since JVM Startup.
27   */
28  @Plugin(name = "RelativeTimePatternConverter", category = PatternConverter.CATEGORY)
29  @ConverterKeys({ "r", "relative" })
30  @PerformanceSensitive("allocation")
31  public class RelativeTimePatternConverter extends LogEventPatternConverter {
32      private final long startTime = ManagementFactory.getRuntimeMXBean().getStartTime();
33  
34      /**
35       * Private constructor.
36       */
37      public RelativeTimePatternConverter() {
38          super("Time", "time");
39      }
40  
41      /**
42       * Obtains an instance of RelativeTimePatternConverter.
43       *
44       * @param options options, currently ignored, may be null.
45       * @return instance of RelativeTimePatternConverter.
46       */
47      public static RelativeTimePatternConverter newInstance(final String[] options) {
48          return new RelativeTimePatternConverter();
49      }
50  
51      /**
52       * {@inheritDoc}
53       */
54      @Override
55      public void format(final LogEvent event, final StringBuilder toAppendTo) {
56          final long timestamp = event.getTimeMillis();
57          toAppendTo.append(timestamp - startTime);
58      }
59  }