Added contributors file; updates to readme.md; fixed appassembler plugin configuration

Author: Ville Koskela

CONTRIBUTORS.md

@@ -0,0 +1,9 @@
+Contributors
+============
+
+The following people have made source contributions to the metrics aggregator daemon project:
+
+* Brandon Arp (barp at groupon dot com)
+* Ville Koskela (vkoskela at groupon dot com)
+
+© Groupon Inc., 2016

README.md

@@ -1,51 +1,56 @@
 Metrics Cluster Aggregator
 ==========================
 
-Combines aggregate values from multiple TSD Aggregators into an aggregate.  Simply, this means combining the values from your fleet.
-
-
-Setup
+<a href="https://raw.githubusercontent.com/ArpNetworking/metrics-cluster-aggregator/master/LICENSE">
+    <img src="https://img.shields.io/hexpm/l/plug.svg"
+         alt="License: Apache 2">
+</a>
+<a href="https://travis-ci.org/ArpNetworking/metrics-cluster-aggregator/">
+    <img src="https://travis-ci.org/ArpNetworking/metrics-cluster-aggregator.png"
+         alt="Travis Build">
+</a>
+<a href="http://search.maven.org/#search%7Cga%7C1%7Cg%3A%22com.arpnetworking.metrics%22%20a%3A%22metrics-cluster-aggregator%22">
+    <img src="https://img.shields.io/maven-central/v/com.arpnetworking.metrics/metrics-cluster-aggregator.svg"
+         alt="Maven Artifact">
+</a>
+
+Reaggregates statistics received from multiple Metric Aggregator Daemon instances into aggregates across each cluster.  Simply, this means combining the values from each host in your fleet.  Both the host and cluster values are published to various configurable data sinks.
+
+
+Usage
 -----
 
-### Building ###
-
-Prerequisites:
-* [JDK8](http://www.oracle.com/technetwork/java/javase/downloads/jdk8-downloads-2133151.html)
-
-Building:
-
-    metrics-cluster-aggregator> ./mvnw install
-
-### Installing ###
+### Installation
 
 The artifacts from the build are in *metrics-cluster-aggregator/target/appassembler* and should be copied to an appropriate directory on your application host(s).
 
-### Execution ###
+### Execution
 
-In the installation's *bin* directory there are scripts to start Metrics Cluster Aggregator: *metrics-cluster-aggregator* (Linux) and *metrics-cluster-aggregator.bat* (Windows).  One of these should be executed on system start with appropriate parameters; for example:
+In the installation's *bin* directory there are scripts to start Metrics Cluster Aggregator: *cluster-aggregator* (Linux) and *cluster-aggregator.bat* (Windows).  One of these should be executed on system start with appropriate parameters; for example:
 
-    /usr/local/lib/metrics-cluster-aggregator/bin/metrics-cluster-aggregator /usr/local/lib/metrics-cluster-aggregator/config/config.json
+    /usr/local/lib/metrics-cluster-aggregator/bin/cluster-aggregator /usr/local/lib/metrics-cluster-aggregator/config/config.json
 
-### Configuration ###
+### Configuration
 
-#### Logging ####
+#### Logging
 
 To customize logging you may provide a [LogBack](http://logback.qos.ch/) configuration file.  To use a custom logging configuration you need to define and export an environment variable before executing *cluster-aggregator*:
 
     export JAVA_OPTS="-Dlogback.configurationFile=/usr/local/lib/metrics-cluster-aggregator/config/logger.xml"
 
 Where */usr/local/lib/metrics-cluster-aggregator/config/logger.xml* is the path to your logging configuration file.
 
-#### Daemon ####
+#### Daemon
 
-The Metrics Cluster Aggregator daemon configuration is specified in a JSON file.  The location of the configuration file is passed to *metrics-cluster-aggregator* as a command line argument:
+The Metrics Cluster Aggregator configuration is specified in a JSON file.  The location of the configuration file is passed to *metrics-cluster-aggregator* as a command line argument:
 
     /usr/local/etc/metrics-cluster-aggregator/config/prod.conf
 
 The configuration specifies:
 
 * logDirectory - The location of additional logs.  This is independent of the logging configuration.
-* pipelineConfiguration - The location of configuration file for the metrics pipeline.
+* clusterPipelineConfiguration - The location of configuration file for the cluster statistics pipeline.
+* hostPipelineConfiguration - The location of the configuration file for the host statistics pipeline.
 * httpHost - The ip address to bind the http server to.
 * httpPort - The port to bind the http server to.
 * aggregationHost - The ip address to bind the tcp aggregation server to.
@@ -129,7 +134,7 @@ For example:
 }
 ```
 
-#### Pipeline ####
+#### Pipeline
 
 Metrics Cluster Aggregator supports a two pipelines.  The first is the host pipeline which handles publication of all statistics received from Metrics Aggregator Daemon instances.  The second is the cluster pipeline which handles all statistics (re)aggregated by cluster across host statistics from Metrics Aggregator Daemon instances.  In both cases the pipeline defines one more destinations or sinks for the statistics.
 
@@ -148,6 +153,30 @@ For example:
 }
 ```
 
+Development
+-----------
+
+To build the service locally you must satisfy these prerequisites:
+* [JDK8](http://www.oracle.com/technetwork/java/javase/downloads/jdk8-downloads-2133151.html)
+
+Next, fork the repository, clone and build:
+
+Building:
+
+    metrics-aggregator-daemon> ./mvnw verify
+
+To use the local version in your project you must first install it locally:
+
+    metrics-aggregator-daemon> ./mvnw install
+
+You can determine the version of the local build from the pom.xml file.  Using the local version is intended only for testing or development.
+
+You may also need to add the local repository to your build in order to pick-up the local version:
+
+* Maven - Included by default.
+* Gradle - Add *mavenLocal()* to *build.gradle* in the *repositories* block.
+* SBT - Add *resolvers += Resolver.mavenLocal* into *project/plugins.sbt*.
+
 License
 -------
 

pom.xml

@@ -200,8 +200,8 @@
         <configuration>
           <programs>
             <program>
-              <id>mad</id>
-              <mainClass>com.arpnetworking.metrics.mad.Main</mainClass>
+              <id>cluster-aggregator</id>
+              <mainClass>com.arpnetworking.metrics.clusteraggregator.Main</mainClass>
             </program>
           </programs>
         </configuration>