open-telemetry
/
opentelemetry-java
mirror of https://github.com/open-telemetry/opentelemetry-java.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Enable OTLP metric export by default in autoconfigure (#4330)

This commit is contained in:
jack-berg 2022-04-04 10:47:43 -05:00 committed by GitHub
parent bc9dafca03
commit cb50ec9ce7
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
6 changed files with 25 additions and 93 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
sdk-extensions/autoconfigure/build.gradle.kts
View File

@ -77,7 +77,6 @@ testing {
targets {
all {
testTask {
environment("OTEL_METRICS_EXPORTER", "otlp")
environment("OTEL_LOGS_EXPORTER", "otlp")
environment("OTEL_RESOURCE_ATTRIBUTES", "service.name=test,cat=meow")
environment("OTEL_PROPAGATORS", "tracecontext,baggage,b3,b3multi,jaeger,ottrace,xray,test")
@ -97,6 +96,7 @@ testing {
all {
testTask {
environment("OTEL_TRACES_EXPORTER", "none")
environment("OTEL_METRICS_EXPORTER", "none")
}
}
}
@ -114,6 +114,7 @@ testing {
targets {
all {
testTask {
environment("OTEL_METRICS_EXPORTER", "none")
environment("OTEL_TRACES_EXPORTER", "jaeger")
environment("OTEL_BSP_SCHEDULE_DELAY", "10")
}
@ -133,14 +134,6 @@ testing {
implementation("com.linecorp.armeria:armeria-grpc")
runtimeOnly("io.grpc:grpc-netty-shaded")
}
targets {
all {
testTask {
environment("OTEL_METRICS_EXPORTER", "otlp")
}
}
}
}
val testOtlpHttp by registering(JvmTestSuite::class) {
dependencies {
@ -156,14 +149,6 @@ testing {
implementation("com.squareup.okhttp3:okhttp-tls")
implementation("io.opentelemetry.proto:opentelemetry-proto")
}
targets {
all {
testTask {
environment("OTEL_METRICS_EXPORTER", "otlp")
}
}
}
}
val testPrometheus by registering(JvmTestSuite::class) {
dependencies {
@ -224,6 +209,7 @@ testing {
targets {
all {
testTask {
environment("OTEL_METRICS_EXPORTER", "none")
environment("OTEL_TRACES_EXPORTER", "zipkin")
environment("OTEL_BSP_SCHEDULE_DELAY", "10")
}

5
sdk-extensions/autoconfigure/src/main/java/io/opentelemetry/sdk/autoconfigure/MeterProviderConfiguration.java
View File

@ -41,7 +41,10 @@ final class MeterProviderConfiguration {
}
String exporterName = config.getString("otel.metrics.exporter");
if (exporterName != null && !exporterName.equals("none")) {
if (exporterName == null) {
exporterName = "otlp";
}
if (!exporterName.equals("none")) {
MetricExporterConfiguration.configureExporter(
exporterName, config, serviceClassLoader, meterProviderBuilder, metricExporterCustomizer);
}

41
sdk-extensions/autoconfigure/src/main/java/io/opentelemetry/sdk/autoconfigure/MetricExporterConfiguration.java
View File

@ -56,11 +56,6 @@ final class MetricExporterConfiguration {
metricExporter = spiExporter;
}
// exporter may be null in otlp case
if (metricExporter == null) {
return;
}
metricExporter = metricExporterCustomizer.apply(metricExporter, config);
sdkMeterProviderBuilder.registerMetricReader(
configurePeriodicMetricReader(config, metricExporter));
@ -89,21 +84,14 @@ final class MetricExporterConfiguration {
}
// Visible for testing
@Nullable
static MetricExporter configureOtlpMetrics(ConfigProperties config) {
String protocol = OtlpConfigUtil.getOtlpProtocol(DATA_TYPE_METRICS, config);
MetricExporter exporter;
if (protocol.equals(PROTOCOL_HTTP_PROTOBUF)) {
try {
ClasspathUtil.checkClassExists(
"io.opentelemetry.exporter.otlp.http.metrics.OtlpHttpMetricExporter",
"OTLP HTTP Metrics Exporter",
"opentelemetry-exporter-otlp-http-metrics");
} catch (ConfigurationException e) {
// Squash this for now, until metrics are stable
return null;
}
ClasspathUtil.checkClassExists(
"io.opentelemetry.exporter.otlp.http.metrics.OtlpHttpMetricExporter",
"OTLP HTTP Metrics Exporter",
"opentelemetry-exporter-otlp-http-metrics");
OtlpHttpMetricExporterBuilder builder = OtlpHttpMetricExporter.builder();
OtlpConfigUtil.configureOtlpExporterBuilder(
@ -118,19 +106,12 @@ final class MetricExporterConfiguration {
retryPolicy -> RetryUtil.setRetryPolicyOnDelegate(builder, retryPolicy));
OtlpConfigUtil.configureOtlpAggregationTemporality(config, builder::setPreferredTemporality);
exporter = builder.build();
return builder.build();
} else if (protocol.equals(PROTOCOL_GRPC)) {
try {
ClasspathUtil.checkClassExists(
"io.opentelemetry.exporter.otlp.metrics.OtlpGrpcMetricExporter",
"OTLP gRPC Metrics Exporter",
"opentelemetry-exporter-otlp-metrics");
} catch (ConfigurationException e) {
// Squash this for now, until metrics are stable and included in the `exporter-otlp`
// artifact
// by default,
return null;
}
ClasspathUtil.checkClassExists(
"io.opentelemetry.exporter.otlp.metrics.OtlpGrpcMetricExporter",
"OTLP gRPC Metrics Exporter",
"opentelemetry-exporter-otlp");
OtlpGrpcMetricExporterBuilder builder = OtlpGrpcMetricExporter.builder();
OtlpConfigUtil.configureOtlpExporterBuilder(
@ -145,12 +126,10 @@ final class MetricExporterConfiguration {
retryPolicy -> RetryUtil.setRetryPolicyOnDelegate(builder, retryPolicy));
OtlpConfigUtil.configureOtlpAggregationTemporality(config, builder::setPreferredTemporality);
exporter = builder.build();
return builder.build();
} else {
throw new ConfigurationException("Unsupported OTLP metrics protocol: " + protocol);
}
return exporter;
}
private static PeriodicMetricReader configurePeriodicMetricReader(

8
sdk-extensions/autoconfigure/src/test/java/io/opentelemetry/sdk/autoconfigure/NotOnClasspathTest.java
View File

@ -119,7 +119,10 @@ class NotOnClasspathTest {
MetricExporterConfiguration.class.getClassLoader(),
SdkMeterProvider.builder(),
(a, unused) -> a))
.doesNotThrowAnyException();
.isInstanceOf(ConfigurationException.class)
.hasMessageContaining(
"OTLP gRPC Metrics Exporter enabled but opentelemetry-exporter-otlp not found on "
+ "classpath");
}
@Test
@ -135,7 +138,8 @@ class NotOnClasspathTest {
MetricExporterConfiguration.class.getClassLoader(),
SdkMeterProvider.builder(),
(a, unused) -> a))
.doesNotThrowAnyException();
.hasMessageContaining(
"OTLP HTTP Metrics Exporter enabled but opentelemetry-exporter-otlp-http-metrics not found on classpath");
}
@Test

42
sdk-extensions/autoconfigure/src/testFullConfig/java/io/opentelemetry/sdk/autoconfigure/ConfigurableMetricExporterTest.java
View File

@ -5,27 +5,17 @@
package io.opentelemetry.sdk.autoconfigure;
import static io.opentelemetry.sdk.autoconfigure.OtlpConfigUtil.PROTOCOL_HTTP_PROTOBUF;
import static org.assertj.core.api.Assertions.as;
import static org.assertj.core.api.Assertions.assertThat;
import static org.assertj.core.api.Assertions.assertThatThrownBy;
import static org.mockito.ArgumentMatchers.any;
import static org.mockito.Mockito.never;
import static org.mockito.Mockito.spy;
import static org.mockito.Mockito.verify;
import com.google.common.collect.ImmutableMap;
import io.opentelemetry.sdk.autoconfigure.spi.ConfigProperties;
import io.opentelemetry.sdk.autoconfigure.spi.ConfigurationException;
import io.opentelemetry.sdk.metrics.SdkMeterProvider;
import io.opentelemetry.sdk.metrics.SdkMeterProviderBuilder;
import io.opentelemetry.sdk.metrics.export.MetricExporter;
import io.opentelemetry.sdk.metrics.export.MetricReader;
import java.net.URL;
import java.net.URLClassLoader;
import java.util.Collections;
import java.util.function.BiFunction;
import org.assertj.core.api.InstanceOfAssertFactories;
import org.junit.jupiter.api.Test;
public class ConfigurableMetricExporterTest {
@ -71,36 +61,4 @@ public class ConfigurableMetricExporterTest {
.isInstanceOf(ConfigurationException.class)
.hasMessageContaining("catExporter");
}
@Test
void configureExporter_OtlpHttpExporterNotOnClasspath() {
// Use the OTLP http/protobuf exporter which is not on the classpath
ConfigProperties configProperties =
DefaultConfigProperties.createForTest(
ImmutableMap.of("otel.exporter.otlp.protocol", PROTOCOL_HTTP_PROTOBUF));
SdkMeterProviderBuilder meterProviderBuilder = SdkMeterProvider.builder();
BiFunction<? super MetricExporter, ConfigProperties, ? extends MetricExporter>
metricCustomizer =
spy(
new BiFunction<MetricExporter, ConfigProperties, MetricExporter>() {
@Override
public MetricExporter apply(
MetricExporter metricExporter, ConfigProperties configProperties) {
return metricExporter;
}
});
MetricExporterConfiguration.configureExporter(
"otlp",
configProperties,
MetricExporterConfiguration.class.getClassLoader(),
meterProviderBuilder,
metricCustomizer);
// Should not call customizer or register a metric reader
verify(metricCustomizer, never()).apply(any(), any());
assertThat(meterProviderBuilder)
.extracting("metricReaders", as(InstanceOfAssertFactories.list(MetricReader.class)))
.hasSize(0);
}
}

2
sdk-extensions/metric-incubator/src/test/java/io/opentelemetry/sdk/viewconfig/ViewConfigCustomizerTest.java
View File

@ -33,6 +33,8 @@ class ViewConfigCustomizerTest {
return ImmutableMap.of(
"otel.traces.exporter",
"none",
"otel.metrics.exporter",
"none",
"otel.experimental.metrics.view.config",
"classpath:/view-config-customizer-test.yaml");
})