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