diff options
author | Mayur Kale <mayurkale@google.com> | 2018-10-17 22:19:10 -0700 |
---|---|---|
committer | GitHub <noreply@github.com> | 2018-10-17 22:19:10 -0700 |
commit | b98e4b90687833108cb497d0bc61311ff662db7c (patch) | |
tree | 1eb8e8d3136088949708abc4498cc4477811f977 /impl_core | |
parent | 30b613fcbf329bf130ae18267b431c4f820bbe28 (diff) | |
download | opencensus-java-b98e4b90687833108cb497d0bc61311ff662db7c.tar.gz |
Add support for DerivedLongGauge (#1497)
* Add support for DerivedLongGauge
* Fix minor issues
* Fix test
* Fix review comments
* Add checker annotation
* fix checker
Diffstat (limited to 'impl_core')
-rw-r--r-- | impl_core/src/main/java/io/opencensus/implcore/metrics/DerivedLongGaugeImpl.java | 152 | ||||
-rw-r--r-- | impl_core/src/test/java/io/opencensus/implcore/metrics/DerivedLongGaugeImplTest.java | 224 |
2 files changed, 376 insertions, 0 deletions
diff --git a/impl_core/src/main/java/io/opencensus/implcore/metrics/DerivedLongGaugeImpl.java b/impl_core/src/main/java/io/opencensus/implcore/metrics/DerivedLongGaugeImpl.java new file mode 100644 index 00000000..b325b163 --- /dev/null +++ b/impl_core/src/main/java/io/opencensus/implcore/metrics/DerivedLongGaugeImpl.java @@ -0,0 +1,152 @@ +/* + * Copyright 2018, OpenCensus Authors + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package io.opencensus.implcore.metrics; + +import static com.google.common.base.Preconditions.checkArgument; +import static com.google.common.base.Preconditions.checkNotNull; + +import io.opencensus.common.Clock; +import io.opencensus.common.ToLongFunction; +import io.opencensus.implcore.internal.Utils; +import io.opencensus.metrics.DerivedLongGauge; +import io.opencensus.metrics.LabelKey; +import io.opencensus.metrics.LabelValue; +import io.opencensus.metrics.export.Metric; +import io.opencensus.metrics.export.MetricDescriptor; +import io.opencensus.metrics.export.MetricDescriptor.Type; +import io.opencensus.metrics.export.Point; +import io.opencensus.metrics.export.TimeSeries; +import io.opencensus.metrics.export.Value; +import java.lang.ref.WeakReference; +import java.util.ArrayList; +import java.util.Collections; +import java.util.LinkedHashMap; +import java.util.List; +import java.util.Map; + +/*>>> +import org.checkerframework.checker.nullness.qual.Nullable; +*/ + +/** Implementation of {@link DerivedLongGauge}. */ +public final class DerivedLongGaugeImpl extends DerivedLongGauge implements Meter { + private final MetricDescriptor metricDescriptor; + private final int labelKeysSize; + + @SuppressWarnings("rawtypes") + private volatile Map<List<LabelValue>, PointWithFunction> registeredPoints = + Collections.emptyMap(); + + DerivedLongGaugeImpl(String name, String description, String unit, List<LabelKey> labelKeys) { + labelKeysSize = labelKeys.size(); + this.metricDescriptor = + MetricDescriptor.create(name, description, unit, Type.GAUGE_INT64, labelKeys); + } + + @Override + @SuppressWarnings("rawtypes") + public synchronized <T> void createTimeSeries( + List<LabelValue> labelValues, /*@Nullable*/ T obj, ToLongFunction</*@Nullable*/ T> function) { + Utils.checkListElementNotNull( + checkNotNull(labelValues, "labelValues"), "labelValue element should not be null."); + checkArgument(labelKeysSize == labelValues.size(), "Incorrect number of labels."); + checkNotNull(function, "function"); + + List<LabelValue> labelValuesCopy = + Collections.unmodifiableList(new ArrayList<LabelValue>(labelValues)); + + PointWithFunction existingPoint = registeredPoints.get(labelValuesCopy); + if (existingPoint != null) { + throw new IllegalArgumentException( + "A different time series with the same labels already exists."); + } + + PointWithFunction newPoint = new PointWithFunction<T>(labelValuesCopy, obj, function); + // Updating the map of time series happens under a lock to avoid multiple add operations + // to happen in the same time. + Map<List<LabelValue>, PointWithFunction> registeredPointsCopy = + new LinkedHashMap<List<LabelValue>, PointWithFunction>(registeredPoints); + registeredPointsCopy.put(labelValuesCopy, newPoint); + registeredPoints = Collections.unmodifiableMap(registeredPointsCopy); + } + + @Override + @SuppressWarnings("rawtypes") + public synchronized void removeTimeSeries(List<LabelValue> labelValues) { + checkNotNull(labelValues, "labelValues"); + + Map<List<LabelValue>, PointWithFunction> registeredPointsCopy = + new LinkedHashMap<List<LabelValue>, PointWithFunction>(registeredPoints); + if (registeredPointsCopy.remove(labelValues) == null) { + // The element not present, no need to update the current map of time series. + return; + } + registeredPoints = Collections.unmodifiableMap(registeredPointsCopy); + } + + @Override + public synchronized void clear() { + registeredPoints = Collections.emptyMap(); + } + + @javax.annotation.Nullable + @Override + @SuppressWarnings("rawtypes") + public Metric getMetric(Clock clock) { + Map<List<LabelValue>, PointWithFunction> currentRegisteredPoints = registeredPoints; + if (currentRegisteredPoints.isEmpty()) { + return null; + } + + if (currentRegisteredPoints.size() == 1) { + PointWithFunction point = currentRegisteredPoints.values().iterator().next(); + return Metric.createWithOneTimeSeries(metricDescriptor, point.getTimeSeries(clock)); + } + + List<TimeSeries> timeSeriesList = new ArrayList<TimeSeries>(currentRegisteredPoints.size()); + for (Map.Entry<List<LabelValue>, PointWithFunction> entry : + currentRegisteredPoints.entrySet()) { + timeSeriesList.add(entry.getValue().getTimeSeries(clock)); + } + return Metric.create(metricDescriptor, timeSeriesList); + } + + /** Implementation of {@link PointWithFunction} with a obj and a callback function. */ + public static final class PointWithFunction<T> { + private final List<LabelValue> labelValues; + @javax.annotation.Nullable private final WeakReference<T> ref; + private final ToLongFunction</*@Nullable*/ T> function; + + PointWithFunction( + List<LabelValue> labelValues, /*@Nullable*/ + T obj, + ToLongFunction</*@Nullable*/ T> function) { + this.labelValues = labelValues; + ref = obj != null ? new WeakReference<T>(obj) : null; + this.function = function; + } + + private TimeSeries getTimeSeries(Clock clock) { + final T obj = ref != null ? ref.get() : null; + long value = function.applyAsLong(obj); + + // TODO(mayurkale): OPTIMIZATION: Avoid re-evaluate the labelValues all the time (issue#1490). + return TimeSeries.createWithOnePoint( + labelValues, Point.create(Value.longValue(value), clock.now()), null); + } + } +} diff --git a/impl_core/src/test/java/io/opencensus/implcore/metrics/DerivedLongGaugeImplTest.java b/impl_core/src/test/java/io/opencensus/implcore/metrics/DerivedLongGaugeImplTest.java new file mode 100644 index 00000000..ec9cad6c --- /dev/null +++ b/impl_core/src/test/java/io/opencensus/implcore/metrics/DerivedLongGaugeImplTest.java @@ -0,0 +1,224 @@ +/* + * Copyright 2018, OpenCensus Authors + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package io.opencensus.implcore.metrics; + +import static com.google.common.truth.Truth.assertThat; + +import io.opencensus.common.Timestamp; +import io.opencensus.common.ToLongFunction; +import io.opencensus.metrics.LabelKey; +import io.opencensus.metrics.LabelValue; +import io.opencensus.metrics.export.Metric; +import io.opencensus.metrics.export.MetricDescriptor; +import io.opencensus.metrics.export.MetricDescriptor.Type; +import io.opencensus.metrics.export.Point; +import io.opencensus.metrics.export.TimeSeries; +import io.opencensus.metrics.export.Value; +import io.opencensus.testing.common.TestClock; +import java.util.ArrayList; +import java.util.Arrays; +import java.util.Collections; +import java.util.List; +import org.junit.Rule; +import org.junit.Test; +import org.junit.rules.ExpectedException; +import org.junit.runner.RunWith; +import org.junit.runners.JUnit4; + +/** Unit tests for {@link DerivedLongGaugeImpl}. */ +@RunWith(JUnit4.class) +public class DerivedLongGaugeImplTest { + @Rule public ExpectedException thrown = ExpectedException.none(); + + private static final String METRIC_NAME = "name"; + private static final String METRIC_DESCRIPTION = "description"; + private static final String METRIC_UNIT = "1"; + private static final List<LabelKey> LABEL_KEY = + Collections.singletonList(LabelKey.create("key", "key description")); + private static final List<LabelValue> LABEL_VALUES = + Collections.singletonList(LabelValue.create("value")); + private static final List<LabelValue> LABEL_VALUES_1 = + Collections.singletonList(LabelValue.create("value1")); + + private static final Timestamp TEST_TIME = Timestamp.create(1234, 123); + private final TestClock testClock = TestClock.create(TEST_TIME); + + private static final MetricDescriptor METRIC_DESCRIPTOR = + MetricDescriptor.create( + METRIC_NAME, METRIC_DESCRIPTION, METRIC_UNIT, Type.GAUGE_INT64, LABEL_KEY); + + private final DerivedLongGaugeImpl derivedLongGauge = + new DerivedLongGaugeImpl(METRIC_NAME, METRIC_DESCRIPTION, METRIC_UNIT, LABEL_KEY); + + // helper class + public static class QueueManager { + public long size() { + return 2; + } + } + + private static final ToLongFunction<Object> longFunction = + new ToLongFunction<Object>() { + @Override + public long applyAsLong(Object value) { + return 5; + } + }; + private static final ToLongFunction<Object> negativeLongFunction = + new ToLongFunction<Object>() { + @Override + public long applyAsLong(Object value) { + return -200; + } + }; + private static final ToLongFunction<QueueManager> queueManagerFunction = + new ToLongFunction<QueueManager>() { + @Override + public long applyAsLong(QueueManager queue) { + return queue.size(); + } + }; + + @Test + public void createTimeSeries_WithNullLabelValues() { + thrown.expect(NullPointerException.class); + thrown.expectMessage("labelValues"); + derivedLongGauge.createTimeSeries(null, null, longFunction); + } + + @Test + public void createTimeSeries_WithNullElement() { + List<LabelKey> labelKeys = + Arrays.asList(LabelKey.create("key1", "desc"), LabelKey.create("key2", "desc")); + List<LabelValue> labelValues = Arrays.asList(LabelValue.create("value1"), null); + + DerivedLongGaugeImpl derivedLongGauge = + new DerivedLongGaugeImpl(METRIC_NAME, METRIC_DESCRIPTION, METRIC_UNIT, labelKeys); + thrown.expect(NullPointerException.class); + thrown.expectMessage("labelValue element should not be null."); + derivedLongGauge.createTimeSeries(labelValues, null, longFunction); + } + + @Test + public void createTimeSeries_WithInvalidLabelSize() { + List<LabelValue> labelValues = + Arrays.asList(LabelValue.create("value1"), LabelValue.create("value2")); + + thrown.expect(IllegalArgumentException.class); + thrown.expectMessage("Incorrect number of labels."); + derivedLongGauge.createTimeSeries(labelValues, null, longFunction); + } + + @Test + public void createTimeSeries_WithNullFunction() { + thrown.expect(NullPointerException.class); + thrown.expectMessage("function"); + derivedLongGauge.createTimeSeries(LABEL_VALUES, null, null); + } + + @Test + public void createTimeSeries_WithObjFunction() { + derivedLongGauge.createTimeSeries(LABEL_VALUES, new QueueManager(), queueManagerFunction); + + Metric metric = derivedLongGauge.getMetric(testClock); + assertThat(metric).isNotNull(); + assertThat(metric) + .isEqualTo( + Metric.createWithOneTimeSeries( + METRIC_DESCRIPTOR, + TimeSeries.createWithOnePoint( + LABEL_VALUES, Point.create(Value.longValue(2), TEST_TIME), null))); + } + + @Test + public void addTimeSeries_WithNullObj() { + derivedLongGauge.createTimeSeries(LABEL_VALUES, null, negativeLongFunction); + + Metric metric = derivedLongGauge.getMetric(testClock); + assertThat(metric).isNotNull(); + assertThat(metric) + .isEqualTo( + Metric.createWithOneTimeSeries( + METRIC_DESCRIPTOR, + TimeSeries.createWithOnePoint( + LABEL_VALUES, Point.create(Value.longValue(-200), TEST_TIME), null))); + } + + @Test + public void removeTimeSeries() { + derivedLongGauge.createTimeSeries(LABEL_VALUES, null, longFunction); + Metric metric = derivedLongGauge.getMetric(testClock); + assertThat(metric).isNotNull(); + assertThat(metric.getMetricDescriptor()).isEqualTo(METRIC_DESCRIPTOR); + assertThat(metric.getTimeSeriesList().size()).isEqualTo(1); + + derivedLongGauge.removeTimeSeries(LABEL_VALUES); + assertThat(derivedLongGauge.getMetric(testClock)).isNull(); + } + + @Test + public void removeTimeSeries_WithNullLabelValues() { + thrown.expect(NullPointerException.class); + thrown.expectMessage("labelValues"); + derivedLongGauge.removeTimeSeries(null); + } + + @Test + public void multipleMetrics_GetMetric() { + derivedLongGauge.createTimeSeries(LABEL_VALUES, null, longFunction); + derivedLongGauge.createTimeSeries(LABEL_VALUES_1, new QueueManager(), queueManagerFunction); + + List<TimeSeries> expectedTimeSeriesList = new ArrayList<TimeSeries>(); + expectedTimeSeriesList.add( + TimeSeries.createWithOnePoint( + LABEL_VALUES, Point.create(Value.longValue(5), TEST_TIME), null)); + expectedTimeSeriesList.add( + TimeSeries.createWithOnePoint( + LABEL_VALUES_1, Point.create(Value.longValue(2), TEST_TIME), null)); + + Metric metric = derivedLongGauge.getMetric(testClock); + assertThat(metric).isNotNull(); + assertThat(metric.getMetricDescriptor()).isEqualTo(METRIC_DESCRIPTOR); + assertThat(metric.getTimeSeriesList().size()).isEqualTo(2); + assertThat(metric.getTimeSeriesList()).containsExactlyElementsIn(expectedTimeSeriesList); + assertThat(metric.getTimeSeriesList().get(0).getLabelValues().size()).isEqualTo(1); + assertThat(metric.getTimeSeriesList().get(0).getLabelValues().get(0)) + .isEqualTo(LabelValue.create("value")); + assertThat(metric.getTimeSeriesList().get(1).getLabelValues().size()).isEqualTo(1); + assertThat(metric.getTimeSeriesList().get(1).getLabelValues().get(0)) + .isEqualTo(LabelValue.create("value1")); + } + + @Test + public void clear() { + derivedLongGauge.createTimeSeries(LABEL_VALUES, null, longFunction); + derivedLongGauge.createTimeSeries(LABEL_VALUES_1, new QueueManager(), queueManagerFunction); + + Metric metric = derivedLongGauge.getMetric(testClock); + assertThat(metric).isNotNull(); + assertThat(metric.getMetricDescriptor()).isEqualTo(METRIC_DESCRIPTOR); + assertThat(metric.getTimeSeriesList().size()).isEqualTo(2); + + derivedLongGauge.clear(); + assertThat(derivedLongGauge.getMetric(testClock)).isNull(); + } + + @Test + public void empty_GetMetrics() { + assertThat(derivedLongGauge.getMetric(testClock)).isNull(); + } +} |