Skip to content

Commit

Permalink
Consistent naming for metrics SDK implementations with trace (#2325)
Browse files Browse the repository at this point in the history
Signed-off-by: Bogdan Drutu <bogdandrutu@gmail.com>
  • Loading branch information
bogdandrutu authored Dec 17, 2020
1 parent d4141e9 commit b758014
Show file tree
Hide file tree
Showing 27 changed files with 98 additions and 98 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@
import io.opentelemetry.context.Scope;
import io.opentelemetry.exporter.otlp.trace.OtlpGrpcSpanExporter;
import io.opentelemetry.sdk.OpenTelemetrySdk;
import io.opentelemetry.sdk.metrics.MeterSdkProvider;
import io.opentelemetry.sdk.metrics.SdkMeterProvider;
import io.opentelemetry.sdk.metrics.data.MetricData;
import io.opentelemetry.sdk.metrics.data.MetricData.LongPoint;
import io.opentelemetry.sdk.metrics.data.MetricData.Point;
Expand Down Expand Up @@ -246,7 +246,7 @@ private static IntervalMetricReader setupSdk(MetricExporter metricExporter) {
.setMetricExporter(metricExporter)
.setMetricProducers(
Collections.singleton(
((MeterSdkProvider) GlobalMetricsProvider.get()).getMetricProducer()))
((SdkMeterProvider) GlobalMetricsProvider.get()).getMetricProducer()))
.setExportIntervalMillis(1000)
.build();
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ Meter build() {
InstrumentationLibraryInfo instrumentationLibraryInfo =
InstrumentationLibraryInfo.create("io.opentelemetry.sdk.metrics", null);

return new MeterSdk(meterProviderSharedState, instrumentationLibraryInfo);
return new SdkMeter(meterProviderSharedState, instrumentationLibraryInfo);
}
});

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
import io.opentelemetry.api.metrics.GlobalMetricsProvider;
import io.opentelemetry.api.trace.Tracer;
import io.opentelemetry.sdk.common.CompletableResultCode;
import io.opentelemetry.sdk.metrics.MeterSdkProvider;
import io.opentelemetry.sdk.metrics.SdkMeterProvider;
import io.opentelemetry.sdk.metrics.data.MetricData;
import io.opentelemetry.sdk.metrics.data.MetricData.LongPoint;
import io.opentelemetry.sdk.metrics.data.MetricData.Point;
Expand Down Expand Up @@ -56,7 +56,7 @@ public CompletableResultCode shutdown() {
@State(Scope.Benchmark)
public static class BenchmarkState {
private final MetricProducer metricProducer =
((MeterSdkProvider) GlobalMetricsProvider.get()).getMetricProducer();
((SdkMeterProvider) GlobalMetricsProvider.get()).getMetricProducer();
private BatchSpanProcessor processor;
private Tracer tracer;
private Collection<MetricData> allMetrics;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
import io.opentelemetry.api.trace.Tracer;
import io.opentelemetry.api.trace.TracerProvider;
import io.opentelemetry.context.propagation.ContextPropagators;
import io.opentelemetry.sdk.metrics.MeterSdkProvider;
import io.opentelemetry.sdk.metrics.SdkMeterProvider;
import io.opentelemetry.sdk.trace.SdkTracerManagement;
import io.opentelemetry.sdk.trace.SdkTracerProvider;
import java.util.concurrent.atomic.AtomicBoolean;
Expand Down Expand Up @@ -47,13 +47,13 @@ public static SdkTracerManagement getGlobalTracerManagement() {
}

/**
* Returns the global {@link MeterSdkProvider}.
* Returns the global {@link SdkMeterProvider}.
*
* @deprecated this will be removed soon in preparation for the initial otel release.
*/
@Deprecated
public static MeterSdkProvider getGlobalMeterProvider() {
return (MeterSdkProvider) GlobalOpenTelemetry.get().getMeterProvider();
public static SdkMeterProvider getGlobalMeterProvider() {
return (SdkMeterProvider) GlobalOpenTelemetry.get().getMeterProvider();
}

static final AtomicBoolean INITIALIZED_GLOBAL = new AtomicBoolean();
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
import io.opentelemetry.api.trace.TracerProvider;
import io.opentelemetry.context.propagation.ContextPropagators;
import io.opentelemetry.sdk.OpenTelemetrySdk.ObfuscatedTracerProvider;
import io.opentelemetry.sdk.metrics.MeterSdkProvider;
import io.opentelemetry.sdk.metrics.SdkMeterProvider;
import io.opentelemetry.sdk.trace.SdkTracerProvider;
import io.opentelemetry.sdk.trace.SdkTracerProviderBuilder;

Expand Down Expand Up @@ -41,14 +41,14 @@ public OpenTelemetrySdkBuilder setTracerProvider(TracerProvider tracerProvider)

/**
* Sets the {@link MeterProvider} to use.. This can be used to configure tracing settings by
* returning the instance created by a {@link MeterSdkProvider.Builder}.
* returning the instance created by a {@link SdkMeterProvider.Builder}.
*
* @see MeterSdkProvider#builder()
* @see SdkMeterProvider#builder()
*/
@Override
@Deprecated
public OpenTelemetrySdkBuilder setMeterProvider(MeterProvider meterProvider) {
if (!(meterProvider instanceof MeterSdkProvider)) {
if (!(meterProvider instanceof SdkMeterProvider)) {
throw new IllegalArgumentException(
"The OpenTelemetrySdk can only be configured with a MeterSdkProvider");
}
Expand All @@ -70,7 +70,7 @@ public OpenTelemetrySdkBuilder setPropagators(ContextPropagators propagators) {
@Override
public OpenTelemetrySdk build() {
if (meterProvider == null) {
meterProvider = MeterSdkProvider.builder().build();
meterProvider = SdkMeterProvider.builder().build();
}

if (tracerProvider == null) {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@
import io.opentelemetry.context.propagation.TextMapPropagator;
import io.opentelemetry.sdk.OpenTelemetrySdk.ObfuscatedTracerProvider;
import io.opentelemetry.sdk.common.Clock;
import io.opentelemetry.sdk.metrics.MeterSdkProvider;
import io.opentelemetry.sdk.metrics.SdkMeterProvider;
import io.opentelemetry.sdk.resources.Resource;
import io.opentelemetry.sdk.trace.IdGenerator;
import io.opentelemetry.sdk.trace.SdkTracerProvider;
Expand All @@ -38,7 +38,7 @@
class OpenTelemetrySdkTest {

@Mock private SdkTracerProvider tracerProvider;
@Mock private MeterSdkProvider meterProvider;
@Mock private SdkMeterProvider meterProvider;
@Mock private ContextPropagators propagators;
@Mock private Clock clock;

Expand Down Expand Up @@ -91,7 +91,7 @@ void testBuilderDefaults() {
obfuscatedTracerProvider ->
assertThat(obfuscatedTracerProvider.unobfuscate())
.isInstanceOf(SdkTracerProvider.class));
assertThat(openTelemetry.getMeterProvider()).isInstanceOf(MeterSdkProvider.class);
assertThat(openTelemetry.getMeterProvider()).isInstanceOf(SdkMeterProvider.class);
}

@Test
Expand Down Expand Up @@ -123,7 +123,7 @@ void testConfiguration_tracerSettings() {
.setTraceConfig(traceConfig)
.build())
.setMeterProvider(
MeterSdkProvider.builder().setResource(resource).setClock(clock).build())
SdkMeterProvider.builder().setResource(resource).setClock(clock).build())
.build();
TracerProvider unobfuscatedTracerProvider =
((ObfuscatedTracerProvider) openTelemetry.getTracerProvider()).unobfuscate();
Expand All @@ -138,7 +138,7 @@ void testConfiguration_tracerSettings() {
.hasFieldOrPropertyWithValue("idGenerator", idGenerator)
.hasFieldOrPropertyWithValue("activeTraceConfig", traceConfig);

assertThat(openTelemetry.getMeterProvider()).isInstanceOf(MeterSdkProvider.class);
assertThat(openTelemetry.getMeterProvider()).isInstanceOf(SdkMeterProvider.class);
// Since MeterProvider is in a different package, the only alternative to this reflective
// approach would be to make the fields public for testing which is worse than this.
assertThat(openTelemetry.getMeterProvider())
Expand Down Expand Up @@ -194,7 +194,7 @@ void fullOpenTelemetrySdkConfigurationDemo() {
.setTraceConfig(newConfig)
.build())
.setMeterProvider(
MeterSdkProvider.builder()
SdkMeterProvider.builder()
.setClock(mock(Clock.class))
.setResource(mock(Resource.class))
.build());
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,12 +12,12 @@
import java.util.Collection;
import java.util.List;

/** {@link MeterSdk} is SDK implementation of {@link Meter}. */
final class MeterSdk implements Meter {
/** {@link SdkMeter} is SDK implementation of {@link Meter}. */
final class SdkMeter implements Meter {
private final MeterProviderSharedState meterProviderSharedState;
private final MeterSharedState meterSharedState;

MeterSdk(
SdkMeter(
MeterProviderSharedState meterProviderSharedState,
InstrumentationLibraryInfo instrumentationLibraryInfo) {
this.meterProviderSharedState = meterProviderSharedState;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -25,34 +25,34 @@
import javax.annotation.Nullable;

/**
* {@code Meter} provider implementation for {@link MeterProvider}.
* {@code SdkMeterProvider} implementation for {@link MeterProvider}.
*
* <p>This class is not intended to be used in application code and it is used only by {@link
* OpenTelemetry}.
*/
public final class MeterSdkProvider implements MeterProvider {
public final class SdkMeterProvider implements MeterProvider {

private static final Logger LOGGER = Logger.getLogger(MeterSdkProvider.class.getName());
private static final Logger LOGGER = Logger.getLogger(SdkMeterProvider.class.getName());
static final String DEFAULT_METER_NAME = "unknown";
private final ComponentRegistry<MeterSdk> registry;
private final ComponentRegistry<SdkMeter> registry;
private final MetricProducer metricProducer;
private final MeterProviderSharedState sharedState;

private MeterSdkProvider(Clock clock, Resource resource) {
private SdkMeterProvider(Clock clock, Resource resource) {
this.sharedState = MeterProviderSharedState.create(clock, resource);
this.registry =
new ComponentRegistry<>(
instrumentationLibraryInfo -> new MeterSdk(sharedState, instrumentationLibraryInfo));
instrumentationLibraryInfo -> new SdkMeter(sharedState, instrumentationLibraryInfo));
this.metricProducer = new MetricProducerSdk(this.registry);
}

@Override
public MeterSdk get(String instrumentationName) {
public SdkMeter get(String instrumentationName) {
return get(instrumentationName, null);
}

@Override
public MeterSdk get(String instrumentationName, @Nullable String instrumentationVersion) {
public SdkMeter get(String instrumentationName, @Nullable String instrumentationVersion) {
// Per the spec, both null and empty are "invalid" and a "default" should be used.
if (instrumentationName == null || instrumentationName.isEmpty()) {
LOGGER.fine("Meter requested without instrumentation name.");
Expand All @@ -78,16 +78,16 @@ public MetricProducer getMetricProducer() {
}

/**
* Returns a new {@link Builder} for {@link MeterSdkProvider}.
* Returns a new {@link Builder} for {@link SdkMeterProvider}.
*
* @return a new {@link Builder} for {@link MeterSdkProvider}.
* @return a new {@link Builder} for {@link SdkMeterProvider}.
*/
public static Builder builder() {
return new Builder();
}

/**
* Builder class for the {@link MeterSdkProvider}. Has fully functional default implementations of
* Builder class for the {@link SdkMeterProvider}. Has fully functional default implementations of
* all three required interfaces.
*/
public static final class Builder {
Expand Down Expand Up @@ -126,8 +126,8 @@ public Builder setResource(@Nonnull Resource resource) {
*
* @return An initialized TracerSdkFactory.
*/
public MeterSdkProvider build() {
return new MeterSdkProvider(clock, resource);
public SdkMeterProvider build() {
return new SdkMeterProvider(clock, resource);
}
}

Expand Down Expand Up @@ -160,17 +160,17 @@ public void registerView(InstrumentSelector selector, AggregationConfiguration s
}

private static final class MetricProducerSdk implements MetricProducer {
private final ComponentRegistry<MeterSdk> registry;
private final ComponentRegistry<SdkMeter> registry;

private MetricProducerSdk(ComponentRegistry<MeterSdk> registry) {
private MetricProducerSdk(ComponentRegistry<SdkMeter> registry) {
this.registry = registry;
}

@Override
public Collection<MetricData> collectAllMetrics() {
Collection<MeterSdk> meters = registry.getComponents();
Collection<SdkMeter> meters = registry.getComponents();
List<MetricData> result = new ArrayList<>(meters.size());
for (MeterSdk meter : meters) {
for (SdkMeter meter : meters) {
result.addAll(meter.collectAll());
}
return Collections.unmodifiableCollection(result);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@

/**
* Central location for Views to be registered. Registration of a view should eventually be done via
* the {@link io.opentelemetry.sdk.metrics.MeterSdkProvider}.
* the {@link SdkMeterProvider}.
*/
class ViewRegistry {

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
/**
* The SDK implementation of metrics.
*
* @see io.opentelemetry.sdk.metrics.MeterSdkProvider
* @see io.opentelemetry.sdk.metrics.SdkMeterProvider
*/
@ParametersAreNonnullByDefault
package io.opentelemetry.sdk.metrics;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
package io.opentelemetry.sdk.metrics.spi;

import io.opentelemetry.api.OpenTelemetry;
import io.opentelemetry.sdk.metrics.MeterSdkProvider;
import io.opentelemetry.sdk.metrics.SdkMeterProvider;
import io.opentelemetry.spi.metrics.MeterProviderFactory;

/**
Expand All @@ -18,7 +18,7 @@
public final class MeterProviderFactorySdk implements MeterProviderFactory {

@Override
public MeterSdkProvider create() {
return MeterSdkProvider.builder().build();
public SdkMeterProvider create() {
return SdkMeterProvider.builder().build();
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -32,8 +32,8 @@ class BatchRecorderSdkTest {
private final TestClock testClock = TestClock.create();
private final MeterProviderSharedState meterProviderSharedState =
MeterProviderSharedState.create(testClock, RESOURCE);
private final MeterSdk testSdk =
new MeterSdk(meterProviderSharedState, INSTRUMENTATION_LIBRARY_INFO);
private final SdkMeter testSdk =
new SdkMeter(meterProviderSharedState, INSTRUMENTATION_LIBRARY_INFO);

@Test
void batchRecorder_badLabelSet() {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -33,8 +33,8 @@ class DoubleCounterSdkTest {
private final TestClock testClock = TestClock.create();
private final MeterProviderSharedState meterProviderSharedState =
MeterProviderSharedState.create(testClock, RESOURCE);
private final MeterSdk testSdk =
new MeterSdk(meterProviderSharedState, INSTRUMENTATION_LIBRARY_INFO);
private final SdkMeter testSdk =
new SdkMeter(meterProviderSharedState, INSTRUMENTATION_LIBRARY_INFO);

@Test
void add_PreventNullLabels() {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -29,8 +29,8 @@ class DoubleSumObserverSdkTest {
private final TestClock testClock = TestClock.create();
private final MeterProviderSharedState meterProviderSharedState =
MeterProviderSharedState.create(testClock, RESOURCE);
private final MeterSdk testSdk =
new MeterSdk(meterProviderSharedState, INSTRUMENTATION_LIBRARY_INFO);
private final SdkMeter testSdk =
new SdkMeter(meterProviderSharedState, INSTRUMENTATION_LIBRARY_INFO);

@Test
void collectMetrics_NoCallback() {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -34,8 +34,8 @@ class DoubleUpDownCounterSdkTest {
private final TestClock testClock = TestClock.create();
private final MeterProviderSharedState meterProviderSharedState =
MeterProviderSharedState.create(testClock, RESOURCE);
private final MeterSdk testSdk =
new MeterSdk(meterProviderSharedState, INSTRUMENTATION_LIBRARY_INFO);
private final SdkMeter testSdk =
new SdkMeter(meterProviderSharedState, INSTRUMENTATION_LIBRARY_INFO);

@Test
void add_PreventNullLabels() {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -29,8 +29,8 @@ class DoubleUpDownSumObserverSdkTest {
private final TestClock testClock = TestClock.create();
private final MeterProviderSharedState meterProviderSharedState =
MeterProviderSharedState.create(testClock, RESOURCE);
private final MeterSdk testSdk =
new MeterSdk(meterProviderSharedState, INSTRUMENTATION_LIBRARY_INFO);
private final SdkMeter testSdk =
new SdkMeter(meterProviderSharedState, INSTRUMENTATION_LIBRARY_INFO);

@Test
void collectMetrics_NoCallback() {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -30,8 +30,8 @@ class DoubleValueObserverSdkTest {
private final TestClock testClock = TestClock.create();
private final MeterProviderSharedState meterProviderSharedState =
MeterProviderSharedState.create(testClock, RESOURCE);
private final MeterSdk testSdk =
new MeterSdk(meterProviderSharedState, INSTRUMENTATION_LIBRARY_INFO);
private final SdkMeter testSdk =
new SdkMeter(meterProviderSharedState, INSTRUMENTATION_LIBRARY_INFO);

@Test
void collectMetrics_NoCallback() {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -37,8 +37,8 @@ class DoubleValueRecorderSdkTest {
private final TestClock testClock = TestClock.create();
private final MeterProviderSharedState meterProviderSharedState =
MeterProviderSharedState.create(testClock, RESOURCE);
private final MeterSdk testSdk =
new MeterSdk(meterProviderSharedState, INSTRUMENTATION_LIBRARY_INFO);
private final SdkMeter testSdk =
new SdkMeter(meterProviderSharedState, INSTRUMENTATION_LIBRARY_INFO);

@Test
void record_PreventNullLabels() {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -34,8 +34,8 @@ class LongCounterSdkTest {
private final TestClock testClock = TestClock.create();
private final MeterProviderSharedState meterProviderSharedState =
MeterProviderSharedState.create(testClock, RESOURCE);
private final MeterSdk testSdk =
new MeterSdk(meterProviderSharedState, INSTRUMENTATION_LIBRARY_INFO);
private final SdkMeter testSdk =
new SdkMeter(meterProviderSharedState, INSTRUMENTATION_LIBRARY_INFO);

@Test
void add_PreventNullLabels() {
Expand Down
Loading

0 comments on commit b758014

Please sign in to comment.