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