com.amazonaws.services.kinesis.log4j.helpers.AsyncBatchPutHandler.java Source code

Introduction

Here is the source code for com.amazonaws.services.kinesis.log4j.helpers.AsyncBatchPutHandler.java

Source

/*******************************************************************************
 * Copyright 2014 Amazon.com, Inc. or its affiliates. All Rights Reserved.
 * 
 * Licensed under the Apache License, Version 2.0 (the "License").
 * You may not use this file except in compliance with the License.
 * A copy of the License is located at
 * 
 *  http://aws.amazon.com/apache2.0
 * 
 * or in the "license" file accompanying this file. This file 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.amazonaws.services.kinesis.log4j.helpers;

import com.amazonaws.handlers.AsyncHandler;
import com.amazonaws.services.kinesis.model.PutRecordsRequest;
import com.amazonaws.services.kinesis.model.PutRecordsResult;
import org.apache.logging.log4j.LogManager;
import org.apache.logging.log4j.Logger;
import org.joda.time.DateTime;
import org.joda.time.Period;
import org.joda.time.format.PeriodFormat;

/**
 * Gathers information on how many put requests made by AWS SDK's async client,
 * succeeded or failed since the beginning
 */
public class AsyncBatchPutHandler implements AsyncHandler<PutRecordsRequest, PutRecordsResult> {
    private static Logger logger = LogManager.getLogger(AsyncBatchPutHandler.class);
    private String appenderName;
    private long successfulRequestCount;
    private long failedRequestCount;
    private DateTime startTime;
    private AmazonKinesisPutRecordsHelper amazonKinesisPutRecordsHelper;

    public AsyncBatchPutHandler(String appenderName, AmazonKinesisPutRecordsHelper amazonKinesisPutRecordsHelper) {
        this.appenderName = appenderName;
        this.startTime = DateTime.now();
        this.amazonKinesisPutRecordsHelper = amazonKinesisPutRecordsHelper;
    }

    /**
     * This method is invoked when there is an exception in sending a log record
     * to Kinesis. These logs would end up in the application log if configured
     * properly.
     */
    @Override
    public void onError(Exception exception) {
        failedRequestCount = failedRequestCount + amazonKinesisPutRecordsHelper.getBatchSize();
        logger.error(
                "Failed to publish a log entry to kinesis using appender: " + appenderName + exception.getMessage(),
                exception);
    }

    /**
     * This method is invoked when a log record is successfully sent to Kinesis.
     * Though this is not too useful for production use cases, it provides a good
     * debugging tool while tweaking parameters for the appender.
     */
    @Override
    public void onSuccess(PutRecordsRequest request, PutRecordsResult result) {
        int currentSuccessfulCount = amazonKinesisPutRecordsHelper
                .getSuccessCountAndaddFailedRecordsBackToQueue(request, result);
        successfulRequestCount = successfulRequestCount + currentSuccessfulCount;

        if ((logger.isInfoEnabled() && (successfulRequestCount + failedRequestCount)
                % amazonKinesisPutRecordsHelper.getBatchSize() == 0) || logger.isDebugEnabled()) {
            logger.info("Appender (" + appenderName + ") made " + successfulRequestCount
                    + " successful put requests out of total " + (successfulRequestCount + failedRequestCount)
                    + " in " + PeriodFormat.getDefault().print(new Period(startTime, DateTime.now()))
                    + " since start");
        }
    }
}