/sumologic-kinesis-connector

Kinesis to Sumo Logic Connector

Primary LanguageJavaApache License 2.0Apache-2.0

Kinesis-Sumologic Connector

The Kinesis-Sumologic Connector is a Java connector that acts as a pipeline between an [Amazon Kinesis] stream and a [Sumologic] Collection. Data gets fetched from the Kinesis Stream, transformed into a POJO and then sent to the Sumologic Collection as JSON. End-user setup instructions can be found in here.

Requirements

  • Java JDK 1.7: This connector has been built with Java version 1.7.
  • Ant: A build.xml script has been provided to build the connector with Ant.
  • AWS Kinesis Account: An Amazon AWS Kinesis account to use as a source of data.
  • Sumologic Account: A Sumologic account to use as a destination.

Overview

Incoming records from one (or many) Shards of an AWS Kinesis Stream will be read using the [Kinesis Client Library]. Records will be:

  • Transformed: Raw records will be transformed into a POJO using a Kinesis Model class and then serialized. The transformer used will be specified in the properties file.
  • Filtered: A filter may be applied to the records. Default filter will let all records pass.
  • Buffered: A custom buffer may be used to define thresholds that, when crossed, will flush all records into the emitter.
  • Emitted: The records will get send to the Sumologic Collector.

Installation

The library can be added to your project using Maven Central just by adding the following dependency to a POM file:

<dependency>
  <groupId>com.sumologic</groupId>
  <artifactId>kinesis-sumologic-connector</artifactId>
  <version>0.1</version>
</dependency>

Configuration

A sample properties file is provided, which should be modified to use your AWS Accounts (accessKey and secretKey), Kinesis Stream(kinesisInputStream), Sumologic HTTP source (sumologicUrl), App Name (appName) and Transformer class used (transformerClass).

Running the Connector

After modifying the .properties file, run the connector by executing the ant build script To download the needed dependencies execute ant setup To build and execute the connector execute ant run

Related sources

Amazon Kinesis

Sumologic

Java JDK 1.7

Ant

AWS Kinesis Account

Sumologic Account

Kinesis Client Library