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.appender;
18  
19  import java.util.Objects;
20  import java.util.concurrent.atomic.AtomicLong;
21  
22  import org.apache.logging.log4j.core.Appender;
23  import org.apache.logging.log4j.core.Core;
24  import org.apache.logging.log4j.core.Layout;
25  import org.apache.logging.log4j.core.LogEvent;
26  import org.apache.logging.log4j.core.config.Property;
27  import org.apache.logging.log4j.core.config.plugins.Plugin;
28  import org.apache.logging.log4j.core.config.plugins.PluginAttribute;
29  import org.apache.logging.log4j.core.config.plugins.PluginFactory;
30  
31  /**
32   * No-Operation Appender that counts events.
33   */
34  @Plugin(name = "CountingNoOp", category = Core.CATEGORY_NAME, elementType = Appender.ELEMENT_TYPE, printObject = true)
35  public class CountingNoOpAppender extends AbstractAppender  {
36  
37      private final AtomicLong total = new AtomicLong();
38  
39      public CountingNoOpAppender(final String name, final Layout<?> layout) {
40          super(name, null, layout, true, Property.EMPTY_ARRAY);
41      }
42  
43      private CountingNoOpAppender(final String name, final Layout<?> layout, final Property[] properties) {
44          super(name, null, layout, true, properties);
45      }
46  
47      public long getCount() {
48          return total.get();
49      }
50  
51      @Override
52      public void append(final LogEvent event) {
53          total.incrementAndGet();
54      }
55  
56      /**
57       * Creates a CountingNoOp Appender.
58       */
59      @PluginFactory
60      public static CountingNoOpAppender createAppender(@PluginAttribute("name") final String name) {
61          return new CountingNoOpAppender(Objects.requireNonNull(name), null, Property.EMPTY_ARRAY);
62      }
63  }