001/* 002 * Licensed to the Apache Software Foundation (ASF) under one or more 003 * contributor license agreements. See the NOTICE file distributed with 004 * this work for additional information regarding copyright ownership. 005 * The ASF licenses this file to You under the Apache license, Version 2.0 006 * (the "License"); you may not use this file except in compliance with 007 * the License. You may obtain a copy of the License at 008 * 009 * http://www.apache.org/licenses/LICENSE-2.0 010 * 011 * Unless required by applicable law or agreed to in writing, software 012 * distributed under the License is distributed on an "AS IS" BASIS, 013 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 014 * See the license for the specific language governing permissions and 015 * limitations under the license. 016 */ 017package org.apache.logging.log4j.core.appender; 018 019import java.util.Objects; 020import java.util.concurrent.atomic.AtomicLong; 021 022import org.apache.logging.log4j.core.Appender; 023import org.apache.logging.log4j.core.Core; 024import org.apache.logging.log4j.core.Layout; 025import org.apache.logging.log4j.core.LogEvent; 026import org.apache.logging.log4j.core.config.Property; 027import org.apache.logging.log4j.core.config.plugins.Plugin; 028import org.apache.logging.log4j.core.config.plugins.PluginAttribute; 029import org.apache.logging.log4j.core.config.plugins.PluginFactory; 030 031/** 032 * No-Operation Appender that counts events. 033 */ 034@Plugin(name = "CountingNoOp", category = Core.CATEGORY_NAME, elementType = Appender.ELEMENT_TYPE, printObject = true) 035public class CountingNoOpAppender extends AbstractAppender { 036 037 private final AtomicLong total = new AtomicLong(); 038 039 public CountingNoOpAppender(final String name, final Layout<?> layout) { 040 super(name, null, layout, true, Property.EMPTY_ARRAY); 041 } 042 043 private CountingNoOpAppender(final String name, final Layout<?> layout, final Property[] properties) { 044 super(name, null, layout, true, properties); 045 } 046 047 public long getCount() { 048 return total.get(); 049 } 050 051 @Override 052 public void append(final LogEvent event) { 053 total.incrementAndGet(); 054 } 055 056 /** 057 * Creates a CountingNoOp Appender. 058 */ 059 @PluginFactory 060 public static CountingNoOpAppender createAppender(@PluginAttribute("name") final String name) { 061 return new CountingNoOpAppender(Objects.requireNonNull(name), null, Property.EMPTY_ARRAY); 062 } 063}