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