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.Layout;
023import org.apache.logging.log4j.core.LogEvent;
024import org.apache.logging.log4j.core.config.plugins.Plugin;
025import org.apache.logging.log4j.core.config.plugins.PluginAttribute;
026import org.apache.logging.log4j.core.config.plugins.PluginFactory;
027
028/**
029 * No-Operation Appender that counts events.
030 */
031@Plugin(name = "CountingNoOp", category = "Core", elementType = "appender", printObject = true)
032public class CountingNoOpAppender extends AbstractAppender  {
033
034    private final AtomicLong total = new AtomicLong();
035
036    public CountingNoOpAppender(final String name, final Layout<?> layout) {
037        super(name, null, layout);
038    }
039
040    public long getCount() {
041        return total.get();
042    }
043
044    @Override
045    public void append(final LogEvent event) {
046        total.incrementAndGet();
047    }
048
049    /**
050     * Creates a CountingNoOp Appender.
051     */
052    @PluginFactory
053    public static CountingNoOpAppender createAppender(@PluginAttribute("name") final String name) {
054        return new CountingNoOpAppender(Objects.requireNonNull(name), null);
055    }
056}