Added properties file sample and readme

Author: Juan Pablo Diaz-Vaz

README.md

@@ -4,23 +4,23 @@ The **Kinesis-Sumologic Connector** is a Java connector that acts as a pipeline
 
 ## 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.
+ + **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 the KinesisMessageModel class and then serialized.
+ + **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.
 
 ## 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**) and App Name (**appName**).
+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
 
@@ -43,4 +43,4 @@ To build and execute the connector execute **ant run**
 
 [Sumologic Account](https://www.sumologic.com/pricing/)
 
-[Kinesis Client Library](https://github.com/awslabs/amazon-kinesis-client/)
+[Kinesis Client Library](https://github.com/awslabs/amazon-kinesis-client/)

SumologicConnector.properties

@@ -0,0 +1,46 @@
+# Fill in your AWS Access Key ID and Secret Access Key
+# http://aws.amazon.com/security-credentials
+accessKey = [ACCESS-KEY]
+secretKey = [SECRET-KEY]
+
+# KinesisConnector Application Settings
+# Since Kinesis Creates a DynamoDB table for each APP,
+# each appName must be unique for different kinesisInputStreams and connectorDestinations
+appName = kinesisToSumologicConnector
+
+# By specifying the region name, the connector will connect from the Amazon Kinesis stream in this region
+# unless the endpoint for Amazon Kinesis is explicitly specified. The Amazon DynamoDB lease table and Amazon CloudWatch
+# metrics for connector will be created in this region. All resources in outgoing destination will 
+# not be affected by this region name.
+regionName = us-east-1
+retryLimit = 3
+
+# Amazon Kinesis parameters for KinesisConnector
+
+# Uncomment the following property if you would like to explicitly configure the Amazon Kinesis endpoint.
+# This property will configure the connector's Amazon Kinesis client to read from this specific endpoint,
+# overwriting the regionName property for ONLY the Amazon Kinesis client. The lease table and Amazon CloudWatch
+# metrics will still use the regionName property.
+# kinesisEndpoint = https\://kinesis.us-west-2.amazonaws.com
+
+# Kinesis Stream where data will be grabbed from
+kinesisInputStream = [STREAM-NAME]
+
+# Optional Amazon Kinesis parameters for automatically creating the stream
+createKinesisInputStream = false
+createKinesisOutputStream = false
+kinesisInputStreamShardCount = 2
+kinesisOutputStreamShardCount = 2
+
+# Transformer class that will be used to handle records
+transformerClass = CloudWatchMessageModelSumologicTransformer
+
+# Specifies the input file from which the StreamSource will read records
+createStreamSource = false
+inputStreamFile = users.txt
+
+# Connector name to be appendend to the UserAgent
+connectorDestination = sumologic
+
+# Sumologic HTTP Collector URL
+sumologicUrl = [SUMOLOGIC-COLLECTOR]