more renaming of Metric to Instrument (#722)

This commit is contained in:
John Watson 2019-12-27 12:45:00 -08:00 committed by Bogdan Drutu
parent 8faa99ee1f
commit 47ed1b1808
9 changed files with 61 additions and 57 deletions

View File

@ -373,8 +373,8 @@ public final class DefaultMeter implements Meter {
}
}
private static final class NoopBuilder extends NoopAbstractMetricBuilder<Builder, DoubleMeasure>
implements Builder {
private static final class NoopBuilder
extends NoopAbstractInstrumentBuilder<Builder, DoubleMeasure> implements Builder {
@Override
protected Builder getThis() {
return this;
@ -418,8 +418,8 @@ public final class DefaultMeter implements Meter {
}
}
private static final class NoopBuilder extends NoopAbstractMetricBuilder<Builder, LongMeasure>
implements Builder {
private static final class NoopBuilder
extends NoopAbstractInstrumentBuilder<Builder, LongMeasure> implements Builder {
@Override
protected Builder getThis() {
return this;
@ -534,7 +534,7 @@ public final class DefaultMeter implements Meter {
}
private abstract static class NoopAbstractGaugeBuilder<B extends Gauge.Builder<B, V>, V>
extends NoopAbstractMetricBuilder<B, V> implements Gauge.Builder<B, V> {
extends NoopAbstractInstrumentBuilder<B, V> implements Gauge.Builder<B, V> {
@Override
public B setMonotonic(boolean monotonic) {
return getThis();
@ -542,7 +542,7 @@ public final class DefaultMeter implements Meter {
}
private abstract static class NoopAbstractCounterBuilder<B extends Counter.Builder<B, V>, V>
extends NoopAbstractMetricBuilder<B, V> implements Counter.Builder<B, V> {
extends NoopAbstractInstrumentBuilder<B, V> implements Counter.Builder<B, V> {
@Override
public B setMonotonic(boolean monotonic) {
return getThis();
@ -550,14 +550,14 @@ public final class DefaultMeter implements Meter {
}
private abstract static class NoopAbstractObserverBuilder<B extends Observer.Builder<B, V>, V>
extends NoopAbstractMetricBuilder<B, V> implements Observer.Builder<B, V> {
extends NoopAbstractInstrumentBuilder<B, V> implements Observer.Builder<B, V> {
@Override
public B setMonotonic(boolean monotonic) {
return getThis();
}
}
private abstract static class NoopAbstractMetricBuilder<B extends Instrument.Builder<B, V>, V>
private abstract static class NoopAbstractInstrumentBuilder<B extends Instrument.Builder<B, V>, V>
implements Instrument.Builder<B, V> {
@Override
public B setDescription(String description) {

View File

@ -19,7 +19,7 @@ package io.opentelemetry.sdk.metrics;
import io.opentelemetry.metrics.Counter;
abstract class AbstractCounterBuilder<B extends Counter.Builder<B, V>, V>
extends AbstractMetricBuilder<B, V> implements Counter.Builder<B, V> {
extends AbstractInstrumentBuilder<B, V> implements Counter.Builder<B, V> {
private boolean monotonic = true;
protected AbstractCounterBuilder(String name) {

View File

@ -19,7 +19,7 @@ package io.opentelemetry.sdk.metrics;
import io.opentelemetry.metrics.Gauge;
abstract class AbstractGaugeBuilder<B extends Gauge.Builder<B, V>, V>
extends AbstractMetricBuilder<B, V> implements Gauge.Builder<B, V> {
extends AbstractInstrumentBuilder<B, V> implements Gauge.Builder<B, V> {
private boolean monotonic = false;
protected AbstractGaugeBuilder(String name) {

View File

@ -25,7 +25,7 @@ import java.util.HashMap;
import java.util.List;
import java.util.Map;
abstract class AbstractMetricBuilder<B extends Instrument.Builder<B, V>, V>
abstract class AbstractInstrumentBuilder<B extends Instrument.Builder<B, V>, V>
implements Instrument.Builder<B, V> {
/* VisibleForTesting */ static final int NAME_MAX_LENGTH = 255;
/* VisibleForTesting */ static final String ERROR_MESSAGE_INVALID_NAME =
@ -39,7 +39,7 @@ abstract class AbstractMetricBuilder<B extends Instrument.Builder<B, V>, V>
private List<String> labelKeys = Collections.emptyList();
private Map<String, String> constantLabels = Collections.emptyMap();
AbstractMetricBuilder(String name) {
AbstractInstrumentBuilder(String name) {
Utils.checkNotNull(name, "name");
Utils.checkArgument(
StringUtils.isPrintableString(name) && name.length() <= NAME_MAX_LENGTH,

View File

@ -19,7 +19,7 @@ package io.opentelemetry.sdk.metrics;
import io.opentelemetry.metrics.Observer;
abstract class AbstractObserverBuilder<B extends Observer.Builder<B, V>, V>
extends AbstractMetricBuilder<B, V> implements Observer.Builder<B, V> {
extends AbstractInstrumentBuilder<B, V> implements Observer.Builder<B, V> {
private boolean monotonic = false;
protected AbstractObserverBuilder(String name) {

View File

@ -35,7 +35,7 @@ public class AbstractCounterBuilderTest {
@Test
public void defaultValue() {
TestMetricBuilder testMetricBuilder = TestMetricBuilder.newBuilder(NAME);
TestInstrumentBuilder testMetricBuilder = TestInstrumentBuilder.newBuilder(NAME);
assertThat(testMetricBuilder.getName()).isEqualTo(NAME);
assertThat(testMetricBuilder.getDescription()).isEmpty();
assertThat(testMetricBuilder.getUnit()).isEqualTo("1");
@ -47,24 +47,25 @@ public class AbstractCounterBuilderTest {
@Test
public void setAndGetValues() {
TestMetricBuilder testMetricBuilder = TestMetricBuilder.newBuilder(NAME).setMonotonic(false);
TestInstrumentBuilder testMetricBuilder =
TestInstrumentBuilder.newBuilder(NAME).setMonotonic(false);
assertThat(testMetricBuilder.getName()).isEqualTo(NAME);
assertThat(testMetricBuilder.getMonotonic()).isFalse();
assertThat(testMetricBuilder.build()).isInstanceOf(TestInstrument.class);
}
private static final class TestMetricBuilder
extends AbstractCounterBuilder<TestMetricBuilder, TestInstrument> {
static TestMetricBuilder newBuilder(String name) {
return new TestMetricBuilder(name);
private static final class TestInstrumentBuilder
extends AbstractCounterBuilder<TestInstrumentBuilder, TestInstrument> {
static TestInstrumentBuilder newBuilder(String name) {
return new TestInstrumentBuilder(name);
}
TestMetricBuilder(String name) {
TestInstrumentBuilder(String name) {
super(name);
}
@Override
TestMetricBuilder getThis() {
TestInstrumentBuilder getThis() {
return this;
}

View File

@ -35,7 +35,7 @@ public class AbstractGaugeBuilderTest {
@Test
public void defaultValue() {
TestMetricBuilder testMetricBuilder = TestMetricBuilder.newBuilder(NAME);
TestInstrumentBuilder testMetricBuilder = TestInstrumentBuilder.newBuilder(NAME);
assertThat(testMetricBuilder.getName()).isEqualTo(NAME);
assertThat(testMetricBuilder.getDescription()).isEmpty();
assertThat(testMetricBuilder.getUnit()).isEqualTo("1");
@ -47,24 +47,25 @@ public class AbstractGaugeBuilderTest {
@Test
public void setAndGetValues() {
TestMetricBuilder testMetricBuilder = TestMetricBuilder.newBuilder(NAME).setMonotonic(true);
TestInstrumentBuilder testMetricBuilder =
TestInstrumentBuilder.newBuilder(NAME).setMonotonic(true);
assertThat(testMetricBuilder.getName()).isEqualTo(NAME);
assertThat(testMetricBuilder.getMonotonic()).isTrue();
assertThat(testMetricBuilder.build()).isInstanceOf(TestInstrument.class);
}
private static final class TestMetricBuilder
extends AbstractGaugeBuilder<TestMetricBuilder, TestInstrument> {
static TestMetricBuilder newBuilder(String name) {
return new TestMetricBuilder(name);
private static final class TestInstrumentBuilder
extends AbstractGaugeBuilder<TestInstrumentBuilder, TestInstrument> {
static TestInstrumentBuilder newBuilder(String name) {
return new TestInstrumentBuilder(name);
}
TestMetricBuilder(String name) {
TestInstrumentBuilder(String name) {
super(name);
}
@Override
TestMetricBuilder getThis() {
TestInstrumentBuilder getThis() {
return this;
}

View File

@ -30,7 +30,7 @@ import org.junit.rules.ExpectedException;
import org.junit.runner.RunWith;
import org.junit.runners.JUnit4;
/** Unit tests for {@link AbstractMetricBuilder}. */
/** Unit tests for {@link AbstractInstrumentBuilder}. */
@RunWith(JUnit4.class)
public class AbstractInstrumentBuilderTest {
@Rule public ExpectedException thrown = ExpectedException.none();
@ -46,63 +46,64 @@ public class AbstractInstrumentBuilderTest {
public void preventNull_Name() {
thrown.expect(NullPointerException.class);
thrown.expectMessage("name");
TestMetricBuilder.newBuilder(null);
TestInstrumentBuilder.newBuilder(null);
}
@Test
public void preventNonPrintableName() {
thrown.expect(IllegalArgumentException.class);
TestMetricBuilder.newBuilder("\2");
TestInstrumentBuilder.newBuilder("\2");
}
@Test
public void preventTooLongName() {
char[] chars = new char[AbstractMetricBuilder.NAME_MAX_LENGTH + 1];
char[] chars = new char[AbstractInstrumentBuilder.NAME_MAX_LENGTH + 1];
Arrays.fill(chars, 'a');
String longName = String.valueOf(chars);
thrown.expect(IllegalArgumentException.class);
thrown.expectMessage(AbstractMetricBuilder.ERROR_MESSAGE_INVALID_NAME);
TestMetricBuilder.newBuilder(longName);
thrown.expectMessage(AbstractInstrumentBuilder.ERROR_MESSAGE_INVALID_NAME);
TestInstrumentBuilder.newBuilder(longName);
}
@Test
public void preventNull_Description() {
thrown.expect(NullPointerException.class);
thrown.expectMessage("description");
TestMetricBuilder.newBuilder("metric").setDescription(null);
TestInstrumentBuilder.newBuilder("metric").setDescription(null);
}
@Test
public void preventNull_Unit() {
thrown.expect(NullPointerException.class);
thrown.expectMessage("unit");
TestMetricBuilder.newBuilder("metric").setUnit(null);
TestInstrumentBuilder.newBuilder("metric").setUnit(null);
}
@Test
public void preventNull_LabelKeys() {
thrown.expect(NullPointerException.class);
thrown.expectMessage("labelKeys");
TestMetricBuilder.newBuilder("metric").setLabelKeys(null);
TestInstrumentBuilder.newBuilder("metric").setLabelKeys(null);
}
@Test
public void preventNull_LabelKey() {
thrown.expect(NullPointerException.class);
thrown.expectMessage("labelKey");
TestMetricBuilder.newBuilder("metric").setLabelKeys(Collections.<String>singletonList(null));
TestInstrumentBuilder.newBuilder("metric")
.setLabelKeys(Collections.<String>singletonList(null));
}
@Test
public void preventNull_ConstantLabels() {
thrown.expect(NullPointerException.class);
thrown.expectMessage("constantLabels");
TestMetricBuilder.newBuilder("metric").setConstantLabels(null);
TestInstrumentBuilder.newBuilder("metric").setConstantLabels(null);
}
@Test
public void defaultValue() {
TestMetricBuilder testMetricBuilder = TestMetricBuilder.newBuilder(NAME);
TestInstrumentBuilder testMetricBuilder = TestInstrumentBuilder.newBuilder(NAME);
assertThat(testMetricBuilder.getName()).isEqualTo(NAME);
assertThat(testMetricBuilder.getDescription()).isEmpty();
assertThat(testMetricBuilder.getUnit()).isEqualTo("1");
@ -113,8 +114,8 @@ public class AbstractInstrumentBuilderTest {
@Test
public void setAndGetValues() {
TestMetricBuilder testMetricBuilder =
TestMetricBuilder.newBuilder(NAME)
TestInstrumentBuilder testMetricBuilder =
TestInstrumentBuilder.newBuilder(NAME)
.setDescription(DESCRIPTION)
.setUnit(UNIT)
.setLabelKeys(LABEL_KEY)
@ -127,18 +128,18 @@ public class AbstractInstrumentBuilderTest {
assertThat(testMetricBuilder.build()).isInstanceOf(TestInstrument.class);
}
private static final class TestMetricBuilder
extends AbstractMetricBuilder<TestMetricBuilder, TestInstrument> {
static TestMetricBuilder newBuilder(String name) {
return new TestMetricBuilder(name);
private static final class TestInstrumentBuilder
extends AbstractInstrumentBuilder<TestInstrumentBuilder, TestInstrument> {
static TestInstrumentBuilder newBuilder(String name) {
return new TestInstrumentBuilder(name);
}
TestMetricBuilder(String name) {
TestInstrumentBuilder(String name) {
super(name);
}
@Override
TestMetricBuilder getThis() {
TestInstrumentBuilder getThis() {
return this;
}

View File

@ -36,7 +36,7 @@ public class AbstractObserverBuilderTest {
@Test
public void defaultValue() {
TestMetricBuilder testMetricBuilder = TestMetricBuilder.newBuilder(NAME);
TestInstrumentBuilder testMetricBuilder = TestInstrumentBuilder.newBuilder(NAME);
assertThat(testMetricBuilder.getName()).isEqualTo(NAME);
assertThat(testMetricBuilder.getDescription()).isEmpty();
assertThat(testMetricBuilder.getUnit()).isEqualTo("1");
@ -48,24 +48,25 @@ public class AbstractObserverBuilderTest {
@Test
public void setAndGetValues() {
TestMetricBuilder testMetricBuilder = TestMetricBuilder.newBuilder(NAME).setMonotonic(true);
TestInstrumentBuilder testMetricBuilder =
TestInstrumentBuilder.newBuilder(NAME).setMonotonic(true);
assertThat(testMetricBuilder.getName()).isEqualTo(NAME);
assertThat(testMetricBuilder.getMonotonic()).isTrue();
assertThat(testMetricBuilder.build()).isInstanceOf(TestInstrument.class);
}
private static final class TestMetricBuilder
extends AbstractObserverBuilder<TestMetricBuilder, TestInstrument> {
static TestMetricBuilder newBuilder(String name) {
return new TestMetricBuilder(name);
private static final class TestInstrumentBuilder
extends AbstractObserverBuilder<TestInstrumentBuilder, TestInstrument> {
static TestInstrumentBuilder newBuilder(String name) {
return new TestInstrumentBuilder(name);
}
TestMetricBuilder(String name) {
TestInstrumentBuilder(String name) {
super(name);
}
@Override
TestMetricBuilder getThis() {
TestInstrumentBuilder getThis() {
return this;
}