Skip to content

Commit be51869

Browse files
committed
Deprecate MeterProvider#get(..) methods
1 parent 1f22239 commit be51869

26 files changed

Lines changed: 105 additions & 89 deletions

File tree

api/metrics/src/main/java/io/opentelemetry/api/metrics/MeterProvider.java

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,9 @@ public interface MeterProvider {
2727
* @param instrumentationName The name of the instrumentation library, not the name of the
2828
* instrument*ed* library.
2929
* @return a meter instance.
30+
* @deprecated Use {@link #meterBuilder(String)}
3031
*/
32+
@Deprecated
3133
default Meter get(String instrumentationName) {
3234
return meterBuilder(instrumentationName).build();
3335
}
@@ -40,7 +42,9 @@ default Meter get(String instrumentationName) {
4042
* @param instrumentationVersion The version of the instrumentation library.
4143
* @param schemaUrl Specifies the Schema URL that should be recorded in the emitted metrics.
4244
* @return a meter instance.
45+
* @deprecated Use {@link #meterBuilder(String)}
4346
*/
47+
@Deprecated
4448
default Meter get(String instrumentationName, String instrumentationVersion, String schemaUrl) {
4549
return meterBuilder(instrumentationName)
4650
.setInstrumentationVersion(instrumentationVersion)

api/metrics/src/test/java/io/opentelemetry/api/metrics/internal/NoopMeterProviderTest.java

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -9,12 +9,6 @@
99
import org.junit.jupiter.api.Test;
1010

1111
public class NoopMeterProviderTest {
12-
@Test
13-
void noopMeterProvider_getDoesNotThrow() {
14-
MeterProvider provider = MeterProvider.noop();
15-
provider.get("user-instrumentation");
16-
provider.get("schema-instrumentation", "1.0", "myschema://url");
17-
}
1812

1913
@Test
2014
void noopMeterProvider_builderDoesNotThrow() {

exporters/otlp/common/src/jmh/java/io/opentelemetry/exporter/otlp/internal/GrpcGzipBenchmark.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -74,7 +74,7 @@ public class GrpcGzipBenchmark {
7474
.build()))
7575
.build();
7676

77-
Meter meter1 = meterProvider.get("longinstrumentation");
77+
Meter meter1 = meterProvider.meterBuilder("longinstrumentation").build();
7878
meter1
7979
.gaugeBuilder("gauge")
8080
.setDescription("gauge description")
@@ -102,7 +102,7 @@ public class GrpcGzipBenchmark {
102102
longUpDownCounter.add(-1, Attributes.of(AttributeKey.booleanKey("on"), true));
103103
longUpDownCounter.add(1);
104104

105-
Meter meter2 = meterProvider.get("doubleinstrumentation");
105+
Meter meter2 = meterProvider.meterBuilder("doubleinstrumentation").build();
106106
meter2
107107
.gaugeBuilder("doublegauge")
108108
.setDescription("doublegauge")

exporters/otlp/common/src/jmh/java/io/opentelemetry/exporter/otlp/internal/MetricsRequestMarshalerBenchmark.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,7 @@ public class MetricsRequestMarshalerBenchmark {
6565
.build()))
6666
.build();
6767

68-
Meter meter1 = meterProvider.get("longinstrumentation");
68+
Meter meter1 = meterProvider.meterBuilder("longinstrumentation").build();
6969
meter1
7070
.gaugeBuilder("gauge")
7171
.setDescription("gauge description")
@@ -93,7 +93,7 @@ public class MetricsRequestMarshalerBenchmark {
9393
longUpDownCounter.add(-1, Attributes.of(AttributeKey.booleanKey("on"), true));
9494
longUpDownCounter.add(1);
9595

96-
Meter meter2 = meterProvider.get("doubleinstrumentation");
96+
Meter meter2 = meterProvider.meterBuilder("doubleinstrumentation").build();
9797
meter2
9898
.gaugeBuilder("doublegauge")
9999
.setDescription("doublegauge")

exporters/otlp/common/src/main/java/io/opentelemetry/exporter/otlp/internal/ExporterMetrics.java

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -63,12 +63,14 @@ public void unbind() {
6363
/** Create an instance for recording OTLP gRPC exporter metrics. */
6464
public static ExporterMetrics createGrpc(String type) {
6565
return new ExporterMetrics(
66-
GlobalMeterProvider.get().get("io.opentelemetry.exporters.otlp-grpc"), type);
66+
GlobalMeterProvider.get().meterBuilder("io.opentelemetry.exporters.otlp-grpc").build(),
67+
type);
6768
}
6869

6970
/** Create an instance for recording OTLP http/protobuf exporter metrics. */
7071
public static ExporterMetrics createHttpProtobuf(String type) {
7172
return new ExporterMetrics(
72-
GlobalMeterProvider.get().get("io.opentelemetry.exporters.otlp-http"), type);
73+
GlobalMeterProvider.get().meterBuilder("io.opentelemetry.exporters.otlp-http").build(),
74+
type);
7375
}
7476
}

exporters/otlp/common/src/main/java/io/opentelemetry/exporter/otlp/internal/grpc/OkHttpGrpcExporter.java

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -82,7 +82,10 @@ public final class OkHttpGrpcExporter<T extends Marshaler> implements GrpcExport
8282
this.headers = headers;
8383
this.compressionEnabled = compressionEnabled;
8484

85-
Meter meter = GlobalMeterProvider.get().get("io.opentelemetry.exporters.otlp-grpc-okhttp");
85+
Meter meter =
86+
GlobalMeterProvider.get()
87+
.meterBuilder("io.opentelemetry.exporters.otlp-grpc-okhttp")
88+
.build();
8689
Attributes attributes = Attributes.builder().put("type", type).build();
8790
seen = meter.counterBuilder("otlp.exporter.seen").build().bind(attributes);
8891
LongCounter exported = meter.counterBuilder("otlp.exported.exported").build();

sdk-extensions/autoconfigure/src/testPrometheus/java/io/opentelemetry/sdk/autoconfigure/PrometheusTest.java

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,8 @@ void prometheusExporter() throws Exception {
3636
AutoConfiguredOpenTelemetrySdk.initialize();
3737

3838
GlobalMeterProvider.get()
39-
.get("test")
39+
.meterBuilder("test")
40+
.build()
4041
.gaugeBuilder("test")
4142
.ofLongs()
4243
.buildWithCallback(result -> result.observe(2, Attributes.empty()));

sdk/metrics/src/jmh/java/io/opentelemetry/sdk/metrics/TestSdk.java

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ public enum TestSdk {
2121
new SdkBuilder() {
2222
@Override
2323
Meter build() {
24-
return MeterProvider.noop().get("io.opentelemetry.sdk.metrics");
24+
return MeterProvider.noop().meterBuilder("io.opentelemetry.sdk.metrics").build();
2525
}
2626
}),
2727
SDK_NO_EXEMPLARS(
@@ -35,7 +35,8 @@ Meter build() {
3535
.registerMetricReader(InMemoryMetricReader.create())
3636
.setExemplarFilter(ExemplarFilter.neverSample())
3737
.build()
38-
.get("io.opentelemetry.sdk.metrics");
38+
.meterBuilder("io.opentelemetry.sdk.metrics")
39+
.build();
3940
}
4041
}),
4142
SDK(
@@ -48,7 +49,8 @@ Meter build() {
4849
// Must register reader for real SDK.
4950
.registerMetricReader(InMemoryMetricReader.create())
5051
.build()
51-
.get("io.opentelemetry.sdk.metrics");
52+
.meterBuilder("io.opentelemetry.sdk.metrics")
53+
.build();
5254
}
5355
});
5456

sdk/metrics/src/main/java/io/opentelemetry/sdk/metrics/SdkMeterProvider.java

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,6 @@
3333
import java.util.concurrent.atomic.AtomicLong;
3434
import java.util.function.Supplier;
3535
import java.util.logging.Logger;
36-
import javax.annotation.Nullable;
3736

3837
/** SDK implementation for {@link MeterProvider}. */
3938
public final class SdkMeterProvider implements MeterProvider, Closeable {
@@ -91,7 +90,7 @@ public static SdkMeterProviderBuilder builder() {
9190
}
9291

9392
@Override
94-
public MeterBuilder meterBuilder(@Nullable String instrumentationName) {
93+
public MeterBuilder meterBuilder(String instrumentationName) {
9594
if (instrumentationName == null || instrumentationName.isEmpty()) {
9695
LOGGER.fine("Meter requested without instrumentation name.");
9796
instrumentationName = DEFAULT_METER_NAME;

sdk/metrics/src/test/java/io/opentelemetry/sdk/metrics/SdkDoubleCounterTest.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ class SdkDoubleCounterTest {
3636
.registerMetricReader(sdkMeterReader)
3737
.setResource(RESOURCE)
3838
.build();
39-
private final Meter sdkMeter = sdkMeterProvider.get(getClass().getName());
39+
private final Meter sdkMeter = sdkMeterProvider.meterBuilder(getClass().getName()).build();
4040

4141
@Test
4242
void add_PreventNullAttributes() {

0 commit comments

Comments
 (0)