com.gu.logback.appender.kinesis.helpers.FirehoseStatsReporter.java Source code

Introduction

Here is the source code for com.gu.logback.appender.kinesis.helpers.FirehoseStatsReporter.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.gu.logback.appender.kinesis.helpers;

import com.amazonaws.handlers.AsyncHandler;
import com.amazonaws.services.kinesisfirehose.model.PutRecordRequest;
import com.amazonaws.services.kinesisfirehose.model.PutRecordResult;
import com.gu.logback.appender.kinesis.FirehoseAppender;

/**
 * Gathers information on how many put requests made by AWS SDK's async client,
 * succeeded or failed since the beginning
 */
public class FirehoseStatsReporter implements AsyncHandler<PutRecordRequest, PutRecordResult> {

    private final String appenderName;
    private long successfulRequestCount;
    private long failedRequestCount;
    private final FirehoseAppender<?> appender;

    public FirehoseStatsReporter(FirehoseAppender<?> appender) {
        this.appenderName = appender.getStreamName();
        this.appender = appender;
    }

    /**
     * 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++;
        appender.addError("Failed to publish a log entry to kinesis using appender: " + appenderName, 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(PutRecordRequest request, PutRecordResult result) {
        successfulRequestCount++;
    }
}