Merge pull request #41 from ringcentral/metric-dimension-to-label

#15: rename MetricDimension/MetricDimensionValue to Label/LabelValue

Author: devromik

README.md

@@ -5,12 +5,12 @@
 import com.ringcentral.platform.metrics.counter.Counter;
 import com.ringcentral.platform.metrics.counter.configs.CounterConfig;
 import com.ringcentral.platform.metrics.counter.configs.builders.CounterConfigBuilder;
-import com.ringcentral.platform.metrics.dimensions.MetricDimensionValues;
 import com.ringcentral.platform.metrics.histogram.Histogram;
 import com.ringcentral.platform.metrics.histogram.configs.HistogramConfig;
 import com.ringcentral.platform.metrics.histogram.configs.builders.HistogramConfigBuilder;
 import com.ringcentral.platform.metrics.infoProviders.ConcurrentMaskTreeMetricNamedInfoProvider;
 import com.ringcentral.platform.metrics.infoProviders.PredicativeMetricNamedInfoProvider;
+import com.ringcentral.platform.metrics.labels.LabelValues;
 import com.ringcentral.platform.metrics.names.MetricName;
 import com.ringcentral.platform.metrics.predicates.MetricNamedPredicate;
 import com.ringcentral.platform.metrics.rate.Rate;
@@ -344,7 +344,7 @@ private <C extends VarConfig> MetricConfigBuilder<C> prepareVarConfigBuilder(
             }
         }
 
-        replacePrefixDimensionValues(key, builder);
+        replacePrefixLabelValues(key, builder);
         return builder;
     }
 
@@ -437,7 +437,7 @@ private <C extends CachingVarConfig> MetricConfigBuilder<C> prepareCachingVarCon
             }
         }
 
-        replacePrefixDimensionValues(key, builder);
+        replacePrefixLabelValues(key, builder);
         return builder;
     }
 
@@ -843,7 +843,7 @@ protected <C extends CounterConfig> Counter buildCounter(
             }
         }
 
-        replacePrefixDimensionValues(key, builder);
+        replacePrefixLabelValues(key, builder);
 
         return metricMaker.makeCounter(
             key.name(),
@@ -921,7 +921,7 @@ protected <C extends RateConfig> Rate buildRate(
             }
         }
 
-        replacePrefixDimensionValues(key, builder);
+        replacePrefixLabelValues(key, builder);
 
         return metricMaker.makeRate(
             key.name(),
@@ -999,7 +999,7 @@ protected <C extends HistogramConfig> Histogram buildHistogram(
             }
         }
 
-        replacePrefixDimensionValues(key, builder);
+        replacePrefixLabelValues(key, builder);
 
         return metricMaker.makeHistogram(
             key.name(),
@@ -1077,7 +1077,7 @@ protected <C extends TimerConfig> Timer buildTimer(
             }
         }
 
-        replacePrefixDimensionValues(key, builder);
+        replacePrefixLabelValues(key, builder);
 
         return metricMaker.makeTimer(
             key.name(),
@@ -1277,10 +1277,10 @@ private void notifyMetricRemoved(MetricRegistryListener listener, MetricKey key,
         }
     }
 
-    private void replacePrefixDimensionValues(MetricKey key, MetricConfigBuilder<?> builder) {
-        if (key instanceof PrefixDimensionValuesMetricKey) {
-            MetricDimensionValues dimensionValues = ((PrefixDimensionValuesMetricKey)key).dimensionValues();
-            builder.modify(withMetric().prefix(dimensionValues));
+    private void replacePrefixLabelValues(MetricKey key, MetricConfigBuilder<?> builder) {
+        if (key instanceof PrefixLabelValuesMetricKey) {
+            LabelValues labelValues = ((PrefixLabelValuesMetricKey)key).labelValues();
+            builder.modify(withMetric().prefix(labelValues));
         }
     }
 }

metrics-facade-base/src/main/java/com/ringcentral/platform/metrics/AbstractMeter.java

@@ -1,7 +1,7 @@
 package com.ringcentral.platform.metrics;
 
-import com.ringcentral.platform.metrics.dimensions.MetricDimensionValues;
+import com.ringcentral.platform.metrics.labels.LabelValues;
 
 public interface Meter extends Metric {
-    void removeInstancesFor(MetricDimensionValues dimensionValues);
+    void removeInstancesFor(LabelValues labelValues);
 }

metrics-facade-base/src/main/java/com/ringcentral/platform/metrics/AbstractMetricRegistry.java

@@ -1,9 +1,9 @@
 package com.ringcentral.platform.metrics;
 
-import com.ringcentral.platform.metrics.dimensions.MetricDimension;
-import com.ringcentral.platform.metrics.dimensions.MetricDimensionUtils;
-import com.ringcentral.platform.metrics.dimensions.MetricDimensionValue;
 import com.ringcentral.platform.metrics.histogram.Histogram;
+import com.ringcentral.platform.metrics.labels.Label;
+import com.ringcentral.platform.metrics.labels.LabelUtils;
+import com.ringcentral.platform.metrics.labels.LabelValue;
 import com.ringcentral.platform.metrics.measurables.Measurable;
 import com.ringcentral.platform.metrics.measurables.MeasurableValues;
 import com.ringcentral.platform.metrics.names.MetricNamed;
@@ -12,31 +12,33 @@
 import java.util.Map;
 import java.util.Set;
 
+import static com.ringcentral.platform.metrics.utils.CollectionUtils.isNonEmpty;
+
 public interface MetricInstance extends MetricNamed {
-    default boolean hasDimensionValues() {
-        return MetricDimensionUtils.hasDimensionValues(dimensionValues());
+    default boolean hasLabelValues() {
+        return isNonEmpty(labelValues());
     }
 
-    List<MetricDimensionValue> dimensionValues();
+    List<LabelValue> labelValues();
 
-    default boolean hasDimension(MetricDimension dimension) {
-        return MetricDimensionUtils.hasDimension(dimensionValues(), dimension);
+    default boolean hasLabel(Label label) {
+        return LabelUtils.hasLabel(labelValues(), label);
     }
 
-    default String valueOf(MetricDimension dimension) {
-        return MetricDimensionUtils.valueOf(dimensionValues(), dimension);
+    default String valueOf(Label label) {
+        return LabelUtils.valueOf(labelValues(), label);
     }
 
-    default Map<MetricDimension, MetricDimensionValue> dimensionToValue() {
-        return MetricDimensionUtils.dimensionToValue(dimensionValues());
+    default Map<Label, LabelValue> labelToValue() {
+        return LabelUtils.labelToValue(labelValues());
     }
 
-    default List<MetricDimensionValue> dimensionValuesWithout(MetricDimension dimension, MetricDimension... dimensions) {
-        return MetricDimensionUtils.dimensionValuesWithout(dimensionValues(), dimension, dimensions);
+    default List<LabelValue> labelValuesWithout(Label label, Label... labels) {
+        return LabelUtils.labelValuesWithout(labelValues(), label, labels);
     }
 
     boolean isTotalInstance();
-    boolean isDimensionalTotalInstance();
+    boolean isLabeledMetricTotalInstance();
     boolean isLevelInstance();
 
     Set<Measurable> measurables();

metrics-facade-base/src/main/java/com/ringcentral/platform/metrics/Meter.java

@@ -0,0 +1,71 @@
+package com.ringcentral.platform.metrics;
+
+import com.ringcentral.platform.metrics.labels.LabelValues;
+import com.ringcentral.platform.metrics.names.MetricName;
+
+import static com.ringcentral.platform.metrics.utils.ObjectUtils.hashCodeFor;
+import static com.ringcentral.platform.metrics.utils.Preconditions.checkArgument;
+import static java.util.Objects.requireNonNull;
+
+public class PrefixLabelValuesMetricKey implements MetricKey {
+
+    private final MetricName name;
+    private final LabelValues labelValues;
+    private final int hashCode;
+
+    public static PrefixLabelValuesMetricKey withKey(MetricName name, LabelValues labelValues) {
+        return prefixLabelValuesMetricKey(name, labelValues);
+    }
+
+    public static PrefixLabelValuesMetricKey metricKey(MetricName name, LabelValues labelValues) {
+        return prefixLabelValuesMetricKey(name, labelValues);
+    }
+
+    public static PrefixLabelValuesMetricKey prefixLabelValuesMetricKey(MetricName name, LabelValues labelValues) {
+        return new PrefixLabelValuesMetricKey(name, labelValues);
+    }
+
+    public PrefixLabelValuesMetricKey(MetricName name, LabelValues labelValues) {
+        this.name = requireNonNull(name);
+
+        checkArgument(
+            labelValues != null && !labelValues.isEmpty(),
+            "labelValues is null or empty");
+
+        this.labelValues = labelValues;
+        this.hashCode = hashCodeFor(name, labelValues);
+    }
+
+    @Override
+    public MetricName name() {
+        return name;
+    }
+
+    public LabelValues labelValues() {
+        return labelValues;
+    }
+
+    @Override
+    public boolean equals(Object other) {
+        if (this == other) {
+            return true;
+        }
+
+        if (other == null || getClass() != other.getClass()) {
+            return false;
+        }
+
+        PrefixLabelValuesMetricKey that = (PrefixLabelValuesMetricKey)other;
+
+        if (hashCode != that.hashCode) {
+            return false;
+        }
+
+        return name.equals(that.name) && labelValues.equals(that.labelValues);
+    }
+
+    @Override
+    public int hashCode() {
+        return hashCode;
+    }
+}

metrics-facade-base/src/main/java/com/ringcentral/platform/metrics/MetricInstance.java

@@ -1,7 +1,7 @@
 package com.ringcentral.platform.metrics.configs;
 
 import com.ringcentral.platform.metrics.MetricContext;
-import com.ringcentral.platform.metrics.dimensions.*;
+import com.ringcentral.platform.metrics.labels.*;
 
 import java.util.*;
 
@@ -11,40 +11,40 @@
 public abstract class AbstractMeterConfig<IC extends MeterInstanceConfig, SC extends MeterSliceConfig<IC>>
     extends AbstractMetricConfig implements MeterConfig<IC, SC> {
 
-    private final List<MetricDimension> dimensions;
-    private final MetricDimensionValuesPredicate exclusionPredicate;
+    private final List<Label> labels;
+    private final LabelValuesPredicate exclusionPredicate;
     private final SC allSliceConfig;
     private final Set<SC> sliceConfigs;
 
     protected AbstractMeterConfig(
         boolean enabled,
         String description,
-        MetricDimensionValues prefixDimensionValues,
-        List<MetricDimension> dimensions,
-        MetricDimensionValuesPredicate exclusionPredicate,
+        LabelValues prefixLabelValues,
+        List<Label> labels,
+        LabelValuesPredicate exclusionPredicate,
         SC allSliceConfig,
         Set<SC> sliceConfigs,
         MetricContext context) {
 
         super(
             enabled,
             description,
-            prefixDimensionValues,
+            prefixLabelValues,
             context);
 
-        this.dimensions = dimensions != null ? dimensions : emptyList();
+        this.labels = labels != null ? labels : emptyList();
         this.exclusionPredicate = exclusionPredicate;
         this.allSliceConfig = requireNonNull(allSliceConfig);
         this.sliceConfigs = sliceConfigs != null ? sliceConfigs : emptySet();
     }
 
     @Override
-    public List<MetricDimension> dimensions() {
-        return dimensions;
+    public List<Label> labels() {
+        return labels;
     }
 
     @Override
-    public MetricDimensionValuesPredicate exclusionPredicate() {
+    public LabelValuesPredicate exclusionPredicate() {
         return exclusionPredicate;
     }