usingflume.ch05.S3Sink.java Source code

Introduction

Here is the source code for usingflume.ch05.S3Sink.java

Source

/*
 * 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 usingflume.ch05;

import com.amazonaws.ClientConfiguration;
import com.amazonaws.Protocol;
import com.amazonaws.auth.AWSCredentials;
import com.amazonaws.auth.BasicAWSCredentials;
import com.amazonaws.services.s3.AmazonS3;
import com.amazonaws.services.s3.AmazonS3Client;
import com.amazonaws.services.s3.model.ObjectMetadata;
import com.google.common.base.Preconditions;
import com.google.common.base.Strings;
import org.apache.flume.Context;
import org.apache.flume.Event;
import org.apache.flume.EventDeliveryException;
import org.apache.flume.Transaction;
import org.apache.flume.conf.Configurable;
import org.apache.flume.sink.AbstractSink;

import java.io.ByteArrayInputStream;
import java.io.ByteArrayOutputStream;
import java.nio.ByteBuffer;
import java.util.concurrent.atomic.AtomicLong;

/**
 *
 * S3 Sink implementation
 *
 * Following are the configuration parameters expected
 *
 * <PRE>
 * ------------------------------------------------------------------------
 *  Name      Default Value     Description
 * ------------------------------------------------------------------------
 * awsAccessKeyId   -           AWS Access Key
 * awsSecretKey     -           AWS Secret Key
 * bucket           -           S3 bucket where data is to be uploaded
 * endPoint         -           S3 end point
 * batchSize      1000          Batch Size for uploading events
 * objectPrefix   flumeData-    Prefix to be used for files stored in S3 bucket
 * bufferSize     64K           Buffer Size to be used for storing data before
 *                              writing to S3
 *
 * </PRE>
 */
public class S3Sink extends AbstractSink implements Configurable {

    private String objPrefix;
    private final AtomicLong suffix = new AtomicLong(System.currentTimeMillis());
    private String awsAccessKeyId;
    private String awsSecretKey;
    private String bucket;
    private int batchSize;
    private String endPoint;

    private AmazonS3 connection;

    // 64K buffer.
    public static final int DEFAULT_BUFFER_SIZE = 64 * 1024;
    public static final int DEFAULT_BATCH_SIZE = 1000;
    public static final String DEFAULT_OBJECT_PREFIX = "flumeData-";

    private int bufferSize;

    @Override
    public void start() {
        // Set up Amazon S3 client.
        AWSCredentials credentials = new BasicAWSCredentials(awsAccessKeyId, awsSecretKey);
        ClientConfiguration config = new ClientConfiguration();
        config.setProtocol(Protocol.HTTP);
        connection = new AmazonS3Client(credentials, config);
        connection.setEndpoint(endPoint);
        if (!connection.doesBucketExist(bucket)) {
            connection.createBucket(bucket);
        }
        super.start();
    }

    @Override
    public synchronized void stop() {
        super.stop();
    }

    @Override
    public Status process() throws EventDeliveryException {
        Status status = Status.BACKOFF;
        Transaction tx = null;
        final ByteArrayOutputStream data = new ByteArrayOutputStream(bufferSize);
        try {
            tx = getChannel().getTransaction();
            tx.begin();
            int i = 0;
            for (; i < batchSize; i++) {
                Event e = getChannel().take();
                if (e == null) {
                    break;
                }
                byte[] body = e.getBody();
                data.write(ByteBuffer.allocate(Integer.SIZE / 8).putInt(body.length).array());
                data.write(body);
            }
            if (i != 0) {
                connection.putObject(bucket, objPrefix + suffix.incrementAndGet(),
                        new ByteArrayInputStream(data.toByteArray()), new ObjectMetadata());
                status = Status.READY;
            }
            tx.commit();
        } catch (Exception e) {
            if (tx != null) {
                tx.rollback();
            }
            throw new EventDeliveryException("Error while processing " + "data", e);
        } finally {
            if (tx != null) {
                tx.close();
            }
        }
        return status;
    }

    @Override
    public void configure(Context context) {
        awsAccessKeyId = context.getString("awsAccessKeyId");
        Preconditions.checkArgument(!Strings.isNullOrEmpty(awsAccessKeyId), "AWS Key Id is required");

        awsSecretKey = context.getString("awsSecretKey");
        Preconditions.checkArgument(!Strings.isNullOrEmpty(awsSecretKey), "AWS Secret Key must be specified");

        bucket = context.getString("bucket");
        Preconditions.checkArgument(!Strings.isNullOrEmpty(bucket), "Bucket name must be specified");

        endPoint = context.getString("endPoint");
        Preconditions.checkArgument(!Strings.isNullOrEmpty(endPoint), "Endpoint cannot be null");

        batchSize = context.getInteger("batchSize", DEFAULT_BATCH_SIZE);
        objPrefix = context.getString("objectPrefix", DEFAULT_OBJECT_PREFIX);
        bufferSize = context.getInteger("bufferSize", DEFAULT_BUFFER_SIZE);
    }
}