com.sumologic.log4j.aggregation.BufferFlushingTask Maven / Gradle / Ivy

Go to download
/**
 *    _____ _____ _____ _____    __    _____ _____ _____ _____
 *   |   __|  |  |     |     |  |  |  |     |   __|     |     |
 *   |__   |  |  | | | |  |  |  |  |__|  |  |  |  |-   -|   --|
 *   |_____|_____|_|_|_|_____|  |_____|_____|_____|_____|_____|
 *
 *                UNICORNS AT WARP SPEED SINCE 2010
 *
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */
package com.sumologic.log4j.aggregation;

import com.sumologic.log4j.queue.BufferWithEviction;

import org.apache.logging.log4j.Logger;
import org.apache.logging.log4j.status.StatusLogger;

import java.util.ArrayList;
import java.util.List;

/**
 * Task to perform a single flushing check
 *
 * @author Jose Muniz ([email protected])
 */
public abstract class BufferFlushingTask implements Runnable {
    private static final Logger logger = StatusLogger.getLogger();
    private long timeOfLastFlush = System.currentTimeMillis();
    private BufferWithEviction messageQueue;

    private boolean needsFlushing() {
        long currentTime = System.currentTimeMillis();
        long dateOfNextFlush = timeOfLastFlush + getMaxFlushInterval();

        return (messageQueue.size() >= getMessagesPerRequest()) ||
               (currentTime >= dateOfNextFlush);
    }

    private void flushAndSend() {
        List messages = new ArrayList(messageQueue.size());
        messageQueue.drainTo(messages);

        if (messages.size() > 0) {
            logger.debug(String.format("%s - Flushing and sending out %d messages (%d messages left)",
                    new java.util.Date(),
                    messages.size(),
                    messageQueue.size()));
            Out body = aggregate(messages);
            sendOut(body, getName());
            timeOfLastFlush = System.currentTimeMillis();
        }
    }


    /* Subclasses should define from here */

    abstract protected long getMaxFlushInterval();
    abstract protected long getMessagesPerRequest();
    abstract protected String getName();

    protected BufferFlushingTask(BufferWithEviction messageQueue) {
        this.messageQueue = messageQueue;
    }

    // Given the list of messages, aggregate them into a single Out object
    abstract protected Out aggregate(List messages);
    // Send aggregated message out. Block until we've successfully sent it.
    abstract protected void sendOut(Out body, String name);



    /* Public interface */

    @Override
    public void run() {
        if (needsFlushing()) {
            try {
                flushAndSend();
            }
            catch (Exception e) {
                logger.warn("Exception while attempting to flush and send", e);
            }
        }
    }

}