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.io.File;
20  import java.io.IOException;
21  import java.lang.management.ManagementFactory;
22  
23  import org.apache.logging.log4j.core.LogEvent;
24  import org.apache.logging.log4j.core.config.plugins.Plugin;
25  import org.apache.logging.log4j.util.ProcessIdUtil;
26  
27  @Plugin(name = "ProcessIdPatternConverter", category = "Converter")
28  @ConverterKeys({ "pid", "processId" })
29  public final class ProcessIdPatternConverter extends LogEventPatternConverter {
30      private static final String DEFAULT_DEFAULT_VALUE = "???";
31      private final String pid;
32  
33      /**
34       * Private constructor.
35       */
36      private ProcessIdPatternConverter(final String... options) {
37          super("Process ID", "pid");
38          final String defaultValue = options.length > 0 ? options[0] : DEFAULT_DEFAULT_VALUE;
39          String discoveredPid = ProcessIdUtil.getProcessId();
40          pid = discoveredPid.equals(ProcessIdUtil.DEFAULT_PROCESSID) ? defaultValue : discoveredPid;
41      }
42  
43      /**
44       * Returns the process ID.
45       * @return the process ID
46       */
47      public String getProcessId() {
48          return pid;
49      }
50  
51      public static void main(final String[] args) {
52          System.out.println(new ProcessIdPatternConverter().pid);
53      }
54  
55      /**
56       * Obtains an instance of ProcessIdPatternConverter.
57       *
58       * @param options options, currently ignored, may be null.
59       * @return instance of ProcessIdPatternConverter.
60       */
61      public static ProcessIdPatternConverter newInstance(final String[] options) {
62          return new ProcessIdPatternConverter(options);
63      }
64  
65      /**
66       * {@inheritDoc}
67       */
68      @Override
69      public void format(final LogEvent event, final StringBuilder toAppendTo) {
70          toAppendTo.append(pid);
71      }
72  }