Add dimensions support (#33)

* Dimensions support.

This commit squashes the history of commit edbf443, tagged dimensions-pre-reset,
on top of ArpNetworking/metrics-aggregator-daemon master branch.

Author: PhoenixRion

src/main/java/com/arpnetworking/metrics/mad/Aggregator.java

@@ -54,6 +54,7 @@
  * This class is thread safe.
  *
  * @author Ville Koskela (ville dot koskela at inscopemetrics dot com)
+ * @author Ryan Ascheman (rascheman at groupon dot com)
  */
 // NOTE: The _periodWorkerExecutor is accessed both in synchronized lifecycle methods like launch() and shutdown() but
 // also non-synchronized methods like notify(). Access to _periodWorkerExecutor does not need to be synchronized.
@@ -113,8 +114,9 @@ public void notify(final Observable observable, final Object event) {
                     .log();
             return;
         }
+
         final Record record = (Record) event;
-        final Key key = new DefaultKey(createDimensions(record));
+        final Key key = new DefaultKey(record.getDimensions());
         LOGGER.trace()
                 .setMessage("Processing record")
                 .addData("record", record)
@@ -149,15 +151,6 @@ public String toString() {
         return toLogValue().toString();
     }
 
-    private ImmutableMap<String, String> createDimensions(final Record record) {
-        // TODO(ville): Promote user specified annotations to dimensions.
-        final ImmutableMap.Builder<String, String> dimensionBuilder = ImmutableMap.builder();
-        dimensionBuilder.put(Key.HOST_DIMENSION_KEY, record.getAnnotations().get(Key.HOST_DIMENSION_KEY));
-        dimensionBuilder.put(Key.SERVICE_DIMENSION_KEY, record.getAnnotations().get(Key.SERVICE_DIMENSION_KEY));
-        dimensionBuilder.put(Key.CLUSTER_DIMENSION_KEY, record.getAnnotations().get(Key.CLUSTER_DIMENSION_KEY));
-        return dimensionBuilder.build();
-    }
-
     private List<PeriodWorker> createPeriodWorkers(final Key key) {
         final List<PeriodWorker> periodWorkerList = Lists.newArrayListWithExpectedSize(_periods.size());
         for (final Period period : _periods) {

src/main/java/com/arpnetworking/metrics/mad/model/DefaultRecord.java

@@ -17,22 +17,19 @@
 
 import com.arpnetworking.commons.builder.OvalBuilder;
 import com.arpnetworking.logback.annotations.Loggable;
-import com.arpnetworking.tsdcore.model.Key;
 import com.google.common.base.MoreObjects;
 import com.google.common.base.Objects;
-import com.google.common.base.Strings;
 import com.google.common.collect.ImmutableMap;
-import edu.umd.cs.findbugs.annotations.SuppressFBWarnings;
 import net.sf.oval.constraint.NotEmpty;
 import net.sf.oval.constraint.NotNull;
-import net.sf.oval.constraint.ValidateWithMethod;
 import org.joda.time.DateTime;
 
 /**
  * Default implementation of the <code>Record</code> interface.
  *
  * @author Brandon Arp (brandonarp at gmail dot com)
  * @author Ville Koskela (ville dot koskela at inscopemetrics dot com)
+ * @author Ryan Ascheman (rascheman at groupon dot com)
  */
 @Loggable
 public final class DefaultRecord implements Record {
@@ -69,6 +66,14 @@ public ImmutableMap<String, String> getAnnotations() {
         return _annotations;
     }
 
+    /**
+     * {@inheritDoc}
+     */
+    @Override
+    public ImmutableMap<String, String> getDimensions() {
+        return _dimensions;
+    }
+
     /**
      * {@inheritDoc}
      */
@@ -105,6 +110,7 @@ public String toString() {
                 .add("Id", _id)
                 .add("Time", _time)
                 .add("Annotations", _annotations)
+                .add("Dimensions", _dimensions)
                 .toString();
     }
 
@@ -115,12 +121,14 @@ private DefaultRecord(final Builder builder) {
         _id = builder._id;
         _time = builder._time;
         _annotations = builder._annotations;
+        _dimensions = builder._dimensions;
     }
 
     private final ImmutableMap<String, ? extends Metric> _metrics;
     private final String _id;
     private final DateTime _time;
     private final ImmutableMap<String, String> _annotations;
+    private final ImmutableMap<String, String> _dimensions;
 
     /**
      * Implementation of builder pattern for <code>DefaultRecord</code>.
@@ -181,19 +189,16 @@ public Builder setAnnotations(final ImmutableMap<String, String> value) {
             return this;
         }
 
-        // Called by OVal reflectively
-        @SuppressFBWarnings("UPM_UNCALLED_PRIVATE_METHOD")
-        private boolean validateAnnotations(final ImmutableMap<String, String> annotations) {
-            if (Strings.isNullOrEmpty(annotations.get(Key.HOST_DIMENSION_KEY))) {
-                return false;
-            }
-            if (Strings.isNullOrEmpty(annotations.get(Key.SERVICE_DIMENSION_KEY))) {
-                return false;
-            }
-            if (Strings.isNullOrEmpty(annotations.get(Key.CLUSTER_DIMENSION_KEY))) {
-                return false;
-            }
-            return true;
+        /**
+         * The dimension mappings <code>ImmutableMap</code>. Optional. Default is an empty
+         * <code>ImmutableMap</code>. Cannot be null.
+         *
+         * @param value The dimension mappings <code>ImmutableMap</code>
+         * @return This instance of <code>Builder</code>.
+         */
+        public Builder setDimensions(final ImmutableMap<String, String> value) {
+            _dimensions = value;
+            return this;
         }
 
         @NotNull
@@ -204,7 +209,8 @@ private boolean validateAnnotations(final ImmutableMap<String, String> annotatio
         @NotNull
         private DateTime _time;
         @NotNull
-        @ValidateWithMethod(methodName = "validateAnnotations", parameterType = ImmutableMap.class)
         private ImmutableMap<String, String> _annotations = ImmutableMap.of();
+        @NotNull
+        private ImmutableMap<String, String> _dimensions = ImmutableMap.of();
     }
 }

src/main/java/com/arpnetworking/metrics/mad/model/Record.java

@@ -20,10 +20,11 @@
 
 /**
  * The interface to a record. Records consistent of a timestamp, any number of
- * named metrics and annotations (arbitrary key-value pairs).
+ * named metrics, annotations (arbitrary key-value pairs) and dimensions (arbitrary key-value pairs).
  *
  * @author Brandon Arp (brandonarp at gmail dot com)
  * @author Ville Koskela (ville dot koskela at inscopemetrics dot com)
+ * @author Ryan Ascheman (rascheman at groupon dot com)
  */
 public interface Record {
 
@@ -54,4 +55,11 @@ public interface Record {
      * @return the annotations
      */
     ImmutableMap<String, String> getAnnotations();
+
+    /**
+     * Gets dimensions.
+     *
+     * @return the dimensions
+     */
+    ImmutableMap<String, String> getDimensions();
 }