From 510bcd06f6b5568314dd6fbdca51d0044839f750 Mon Sep 17 00:00:00 2001 From: Jack Berg Date: Mon, 19 Dec 2022 16:23:27 -0600 Subject: [PATCH 1/4] Implement prometheus exporter provider --- exporters/prometheus/build.gradle.kts | 2 + .../PrometheusCustomizerProvider.java | 49 +++++++++++++++ ...re.spi.AutoConfigurationCustomizerProvider | 1 + sdk-extensions/autoconfigure/build.gradle.kts | 2 - .../sdk/autoconfigure/ClasspathUtil.java | 11 +++- .../MeterProviderConfiguration.java | 2 + .../MetricExporterConfiguration.java | 59 ++++++++----------- .../sdk/autoconfigure/NotOnClasspathTest.java | 4 +- .../ConfigurableMetricExporterTest.java | 5 +- 9 files changed, 92 insertions(+), 43 deletions(-) create mode 100644 exporters/prometheus/src/main/java/io/opentelemetry/exporter/prometheus/internal/PrometheusCustomizerProvider.java create mode 100644 exporters/prometheus/src/main/resources/META-INF/services/io.opentelemetry.sdk.autoconfigure.spi.AutoConfigurationCustomizerProvider diff --git a/exporters/prometheus/build.gradle.kts b/exporters/prometheus/build.gradle.kts index 81ca190fa0b..166e34aa7ca 100644 --- a/exporters/prometheus/build.gradle.kts +++ b/exporters/prometheus/build.gradle.kts @@ -11,6 +11,8 @@ otelJava.moduleName.set("io.opentelemetry.exporter.prometheus") dependencies { api(project(":sdk:metrics")) + implementation(project(":sdk-extensions:autoconfigure-spi")) + compileOnly("com.sun.net.httpserver:http") testImplementation("com.google.guava:guava") diff --git a/exporters/prometheus/src/main/java/io/opentelemetry/exporter/prometheus/internal/PrometheusCustomizerProvider.java b/exporters/prometheus/src/main/java/io/opentelemetry/exporter/prometheus/internal/PrometheusCustomizerProvider.java new file mode 100644 index 00000000000..042cedbc3c8 --- /dev/null +++ b/exporters/prometheus/src/main/java/io/opentelemetry/exporter/prometheus/internal/PrometheusCustomizerProvider.java @@ -0,0 +1,49 @@ +/* + * Copyright The OpenTelemetry Authors + * SPDX-License-Identifier: Apache-2.0 + */ + +package io.opentelemetry.exporter.prometheus.internal; + +import io.opentelemetry.exporter.prometheus.PrometheusHttpServer; +import io.opentelemetry.exporter.prometheus.PrometheusHttpServerBuilder; +import io.opentelemetry.sdk.autoconfigure.spi.AutoConfigurationCustomizer; +import io.opentelemetry.sdk.autoconfigure.spi.AutoConfigurationCustomizerProvider; +import io.opentelemetry.sdk.autoconfigure.spi.ConfigProperties; + +/** + * SPI implementation for {@link PrometheusHttpServer}. + * + *

This class is internal and is hence not for public use. Its APIs are unstable and can change + * at any time. + */ +public class PrometheusCustomizerProvider implements AutoConfigurationCustomizerProvider { + + @Override + public void customize(AutoConfigurationCustomizer autoConfiguration) { + autoConfiguration.addMeterProviderCustomizer( + (builder, config) -> { + boolean prometheusEnabled = + config.getList("otel.metrics.exporter").contains("prometheus"); + if (prometheusEnabled) { + builder.registerMetricReader(configurePrometheusHttpServer(config)); + } + return builder; + }); + } + + // Visible for testing + static PrometheusHttpServer configurePrometheusHttpServer(ConfigProperties config) { + PrometheusHttpServerBuilder prometheusBuilder = PrometheusHttpServer.builder(); + + Integer port = config.getInt("otel.exporter.prometheus.port"); + if (port != null) { + prometheusBuilder.setPort(port); + } + String host = config.getString("otel.exporter.prometheus.host"); + if (host != null) { + prometheusBuilder.setHost(host); + } + return prometheusBuilder.build(); + } +} diff --git a/exporters/prometheus/src/main/resources/META-INF/services/io.opentelemetry.sdk.autoconfigure.spi.AutoConfigurationCustomizerProvider b/exporters/prometheus/src/main/resources/META-INF/services/io.opentelemetry.sdk.autoconfigure.spi.AutoConfigurationCustomizerProvider new file mode 100644 index 00000000000..1522bd5c348 --- /dev/null +++ b/exporters/prometheus/src/main/resources/META-INF/services/io.opentelemetry.sdk.autoconfigure.spi.AutoConfigurationCustomizerProvider @@ -0,0 +1 @@ +io.opentelemetry.exporter.prometheus.internal.PrometheusCustomizerProvider \ No newline at end of file diff --git a/sdk-extensions/autoconfigure/build.gradle.kts b/sdk-extensions/autoconfigure/build.gradle.kts index 3b8e983ff0e..c4a9e2169b9 100644 --- a/sdk-extensions/autoconfigure/build.gradle.kts +++ b/sdk-extensions/autoconfigure/build.gradle.kts @@ -14,8 +14,6 @@ dependencies { implementation(project(":semconv")) - compileOnly(project(":exporters:prometheus")) - annotationProcessor("com.google.auto.value:auto-value") testImplementation(project(":sdk:trace-shaded-deps")) diff --git a/sdk-extensions/autoconfigure/src/main/java/io/opentelemetry/sdk/autoconfigure/ClasspathUtil.java b/sdk-extensions/autoconfigure/src/main/java/io/opentelemetry/sdk/autoconfigure/ClasspathUtil.java index 82d67de1145..5eef38cbef3 100644 --- a/sdk-extensions/autoconfigure/src/main/java/io/opentelemetry/sdk/autoconfigure/ClasspathUtil.java +++ b/sdk-extensions/autoconfigure/src/main/java/io/opentelemetry/sdk/autoconfigure/ClasspathUtil.java @@ -9,11 +9,18 @@ final class ClasspathUtil { - @SuppressWarnings("UnusedException") - static void checkClassExists(String className, String featureName, String requiredLibrary) { + static boolean checkClassExists(String className) { try { Class.forName(className); + return true; } catch (ClassNotFoundException unused) { + return false; + } + } + + @SuppressWarnings("UnusedException") + static void checkClassExists(String className, String featureName, String requiredLibrary) { + if (!checkClassExists(className)) { throw new ConfigurationException( featureName + " enabled but " diff --git a/sdk-extensions/autoconfigure/src/main/java/io/opentelemetry/sdk/autoconfigure/MeterProviderConfiguration.java b/sdk-extensions/autoconfigure/src/main/java/io/opentelemetry/sdk/autoconfigure/MeterProviderConfiguration.java index fac7c3ac2bf..53f986a8564 100644 --- a/sdk-extensions/autoconfigure/src/main/java/io/opentelemetry/sdk/autoconfigure/MeterProviderConfiguration.java +++ b/sdk-extensions/autoconfigure/src/main/java/io/opentelemetry/sdk/autoconfigure/MeterProviderConfiguration.java @@ -15,6 +15,7 @@ import io.opentelemetry.sdk.metrics.internal.exemplar.ExemplarFilter; import java.util.Collections; import java.util.List; +import java.util.Objects; import java.util.Set; import java.util.function.BiFunction; import java.util.stream.Collectors; @@ -70,6 +71,7 @@ static List configureMetricReaders( exporterName -> MetricExporterConfiguration.configureReader( exporterName, config, serviceClassLoader, metricExporterCustomizer)) + .filter(Objects::nonNull) .collect(Collectors.toList()); } diff --git a/sdk-extensions/autoconfigure/src/main/java/io/opentelemetry/sdk/autoconfigure/MetricExporterConfiguration.java b/sdk-extensions/autoconfigure/src/main/java/io/opentelemetry/sdk/autoconfigure/MetricExporterConfiguration.java index eec05b99efd..243b3c53fce 100644 --- a/sdk-extensions/autoconfigure/src/main/java/io/opentelemetry/sdk/autoconfigure/MetricExporterConfiguration.java +++ b/sdk-extensions/autoconfigure/src/main/java/io/opentelemetry/sdk/autoconfigure/MetricExporterConfiguration.java @@ -5,8 +5,6 @@ package io.opentelemetry.sdk.autoconfigure; -import io.opentelemetry.exporter.prometheus.PrometheusHttpServer; -import io.opentelemetry.exporter.prometheus.PrometheusHttpServerBuilder; import io.opentelemetry.sdk.autoconfigure.spi.ConfigProperties; import io.opentelemetry.sdk.autoconfigure.spi.ConfigurationException; import io.opentelemetry.sdk.autoconfigure.spi.metrics.ConfigurableMetricExporterProvider; @@ -17,6 +15,7 @@ import java.util.HashMap; import java.util.Map; import java.util.function.BiFunction; +import javax.annotation.Nullable; final class MetricExporterConfiguration { @@ -28,8 +27,10 @@ final class MetricExporterConfiguration { EXPORTER_ARTIFACT_ID_BY_NAME.put("logging", "opentelemetry-exporter-logging"); EXPORTER_ARTIFACT_ID_BY_NAME.put("logging-otlp", "opentelemetry-exporter-logging-otlp"); EXPORTER_ARTIFACT_ID_BY_NAME.put("otlp", "opentelemetry-exporter-otlp"); + // PrometheusHttpServer is a pull based exporter which is configured } + @Nullable static MetricReader configureReader( String name, ConfigProperties config, @@ -37,7 +38,15 @@ static MetricReader configureReader( BiFunction metricExporterCustomizer) { if (name.equals("prometheus")) { - return configurePrometheusMetricReader(config); + if (!ClasspathUtil.checkClassExists( + "io.opentelemetry.exporter.prometheus.PrometheusHttpServer")) { + // PrometheusHttpServer is implemented as MetricReader (not MetricExporter) and uses + // the AutoConfigurationCustomizer#addMeterProviderCustomizer SPI hook instead of + // ConfigurableMetricExporterProvider. While the prometheus SPI hook is not handled here, + // the classpath check here provides uniform exception messages. + throw missingExporterException("prometheus", "opentelemetry-exporter-prometheus"); + } + return null; } NamedSpiManager spiExportersManager = @@ -45,7 +54,10 @@ static MetricReader configureReader( MetricExporter metricExporter = configureExporter(name, spiExportersManager); metricExporter = metricExporterCustomizer.apply(metricExporter, config); - return configurePeriodicMetricReader(config, metricExporter); + + return PeriodicMetricReader.builder(metricExporter) + .setInterval(config.getDuration("otel.metric.export.interval", DEFAULT_EXPORT_INTERVAL)) + .build(); } // Visible for testing @@ -66,42 +78,21 @@ static MetricExporter configureExporter( if (metricExporter == null) { String artifactId = EXPORTER_ARTIFACT_ID_BY_NAME.get(name); if (artifactId != null) { - throw new ConfigurationException( - "otel.metrics.exporter set to \"" - + name - + "\" but " - + artifactId - + " not found on classpath. Make sure to add it as a dependency."); + throw missingExporterException(name, artifactId); } throw new ConfigurationException("Unrecognized value for otel.metrics.exporter: " + name); } return metricExporter; } - private static PeriodicMetricReader configurePeriodicMetricReader( - ConfigProperties config, MetricExporter exporter) { - - return PeriodicMetricReader.builder(exporter) - .setInterval(config.getDuration("otel.metric.export.interval", DEFAULT_EXPORT_INTERVAL)) - .build(); - } - - private static PrometheusHttpServer configurePrometheusMetricReader(ConfigProperties config) { - ClasspathUtil.checkClassExists( - "io.opentelemetry.exporter.prometheus.PrometheusHttpServer", - "Prometheus Metrics Server", - "opentelemetry-exporter-prometheus"); - PrometheusHttpServerBuilder prom = PrometheusHttpServer.builder(); - - Integer port = config.getInt("otel.exporter.prometheus.port"); - if (port != null) { - prom.setPort(port); - } - String host = config.getString("otel.exporter.prometheus.host"); - if (host != null) { - prom.setHost(host); - } - return prom.build(); + private static ConfigurationException missingExporterException( + String exporterName, String artifactId) { + return new ConfigurationException( + "otel.metrics.exporter set to \"" + + exporterName + + "\" but " + + artifactId + + " not found on classpath. Make sure to add it as a dependency."); } private MetricExporterConfiguration() {} diff --git a/sdk-extensions/autoconfigure/src/test/java/io/opentelemetry/sdk/autoconfigure/NotOnClasspathTest.java b/sdk-extensions/autoconfigure/src/test/java/io/opentelemetry/sdk/autoconfigure/NotOnClasspathTest.java index 8486a965fc9..4d751399f47 100644 --- a/sdk-extensions/autoconfigure/src/test/java/io/opentelemetry/sdk/autoconfigure/NotOnClasspathTest.java +++ b/sdk-extensions/autoconfigure/src/test/java/io/opentelemetry/sdk/autoconfigure/NotOnClasspathTest.java @@ -153,8 +153,8 @@ void prometheus() { (a, unused) -> a)) .isInstanceOf(ConfigurationException.class) .hasMessageContaining( - "Prometheus Metrics Server enabled but opentelemetry-exporter-prometheus not found on " - + "classpath"); + "otel.metrics.exporter set to \"prometheus\" but opentelemetry-exporter-prometheus not found on classpath." + + " Make sure to add it as a dependency."); } @Test diff --git a/sdk-extensions/autoconfigure/src/testFullConfig/java/io/opentelemetry/sdk/autoconfigure/ConfigurableMetricExporterTest.java b/sdk-extensions/autoconfigure/src/testFullConfig/java/io/opentelemetry/sdk/autoconfigure/ConfigurableMetricExporterTest.java index bdfb28aa9c3..319d8c9bd7e 100644 --- a/sdk-extensions/autoconfigure/src/testFullConfig/java/io/opentelemetry/sdk/autoconfigure/ConfigurableMetricExporterTest.java +++ b/sdk-extensions/autoconfigure/src/testFullConfig/java/io/opentelemetry/sdk/autoconfigure/ConfigurableMetricExporterTest.java @@ -10,7 +10,6 @@ import com.google.common.collect.ImmutableMap; import io.opentelemetry.exporter.otlp.metrics.OtlpGrpcMetricExporter; -import io.opentelemetry.exporter.prometheus.PrometheusHttpServer; import io.opentelemetry.sdk.autoconfigure.spi.ConfigProperties; import io.opentelemetry.sdk.autoconfigure.spi.ConfigurationException; import io.opentelemetry.sdk.autoconfigure.spi.internal.DefaultConfigProperties; @@ -105,7 +104,7 @@ void defaultExporter() { void configureMultipleMetricExporters() { ConfigProperties config = DefaultConfigProperties.createForTest( - ImmutableMap.of("otel.metrics.exporter", "otlp,prometheus")); + ImmutableMap.of("otel.metrics.exporter", "otlp,logging")); assertThat( MeterProviderConfiguration.configureMetricReaders( @@ -114,7 +113,7 @@ void configureMultipleMetricExporters() { (metricExporter, unused) -> metricExporter)) .hasSize(2) .hasAtLeastOneElementOfType(PeriodicMetricReader.class) - .hasAtLeastOneElementOfType(PrometheusHttpServer.class) + .hasAtLeastOneElementOfType(PeriodicMetricReader.class) .allSatisfy(metricReader -> metricReader.shutdown().join(10, TimeUnit.SECONDS)); } } From 46d655ceed9db6f72f5d88ffdffe8f9a2813c829 Mon Sep 17 00:00:00 2001 From: Jack Berg Date: Tue, 20 Dec 2022 09:18:52 -0600 Subject: [PATCH 2/4] Remove stray comment --- .../sdk/autoconfigure/MetricExporterConfiguration.java | 1 - 1 file changed, 1 deletion(-) diff --git a/sdk-extensions/autoconfigure/src/main/java/io/opentelemetry/sdk/autoconfigure/MetricExporterConfiguration.java b/sdk-extensions/autoconfigure/src/main/java/io/opentelemetry/sdk/autoconfigure/MetricExporterConfiguration.java index 243b3c53fce..eed123d0d15 100644 --- a/sdk-extensions/autoconfigure/src/main/java/io/opentelemetry/sdk/autoconfigure/MetricExporterConfiguration.java +++ b/sdk-extensions/autoconfigure/src/main/java/io/opentelemetry/sdk/autoconfigure/MetricExporterConfiguration.java @@ -27,7 +27,6 @@ final class MetricExporterConfiguration { EXPORTER_ARTIFACT_ID_BY_NAME.put("logging", "opentelemetry-exporter-logging"); EXPORTER_ARTIFACT_ID_BY_NAME.put("logging-otlp", "opentelemetry-exporter-logging-otlp"); EXPORTER_ARTIFACT_ID_BY_NAME.put("otlp", "opentelemetry-exporter-otlp"); - // PrometheusHttpServer is a pull based exporter which is configured } @Nullable From c96e5f28aca84270e11ba72c9e3fc165ea6e79b7 Mon Sep 17 00:00:00 2001 From: Jack Berg Date: Tue, 20 Dec 2022 09:19:04 -0600 Subject: [PATCH 3/4] Adjust method visibility --- .../prometheus/internal/PrometheusCustomizerProvider.java | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/exporters/prometheus/src/main/java/io/opentelemetry/exporter/prometheus/internal/PrometheusCustomizerProvider.java b/exporters/prometheus/src/main/java/io/opentelemetry/exporter/prometheus/internal/PrometheusCustomizerProvider.java index 042cedbc3c8..7b8f7c7715e 100644 --- a/exporters/prometheus/src/main/java/io/opentelemetry/exporter/prometheus/internal/PrometheusCustomizerProvider.java +++ b/exporters/prometheus/src/main/java/io/opentelemetry/exporter/prometheus/internal/PrometheusCustomizerProvider.java @@ -32,8 +32,7 @@ public void customize(AutoConfigurationCustomizer autoConfiguration) { }); } - // Visible for testing - static PrometheusHttpServer configurePrometheusHttpServer(ConfigProperties config) { + private static PrometheusHttpServer configurePrometheusHttpServer(ConfigProperties config) { PrometheusHttpServerBuilder prometheusBuilder = PrometheusHttpServer.builder(); Integer port = config.getInt("otel.exporter.prometheus.port"); From 1a0201355d25318fd52e857c3a4718fe276a1976 Mon Sep 17 00:00:00 2001 From: Jack Berg Date: Wed, 21 Dec 2022 09:40:26 -0600 Subject: [PATCH 4/4] Delete ClasspathUtil --- .../sdk/autoconfigure/ClasspathUtil.java | 34 ------------------- .../MetricExporterConfiguration.java | 15 ++++---- 2 files changed, 8 insertions(+), 41 deletions(-) delete mode 100644 sdk-extensions/autoconfigure/src/main/java/io/opentelemetry/sdk/autoconfigure/ClasspathUtil.java diff --git a/sdk-extensions/autoconfigure/src/main/java/io/opentelemetry/sdk/autoconfigure/ClasspathUtil.java b/sdk-extensions/autoconfigure/src/main/java/io/opentelemetry/sdk/autoconfigure/ClasspathUtil.java deleted file mode 100644 index 5eef38cbef3..00000000000 --- a/sdk-extensions/autoconfigure/src/main/java/io/opentelemetry/sdk/autoconfigure/ClasspathUtil.java +++ /dev/null @@ -1,34 +0,0 @@ -/* - * Copyright The OpenTelemetry Authors - * SPDX-License-Identifier: Apache-2.0 - */ - -package io.opentelemetry.sdk.autoconfigure; - -import io.opentelemetry.sdk.autoconfigure.spi.ConfigurationException; - -final class ClasspathUtil { - - static boolean checkClassExists(String className) { - try { - Class.forName(className); - return true; - } catch (ClassNotFoundException unused) { - return false; - } - } - - @SuppressWarnings("UnusedException") - static void checkClassExists(String className, String featureName, String requiredLibrary) { - if (!checkClassExists(className)) { - throw new ConfigurationException( - featureName - + " enabled but " - + requiredLibrary - + " not found on classpath. " - + "Make sure to add it as a dependency to enable this feature."); - } - } - - private ClasspathUtil() {} -} diff --git a/sdk-extensions/autoconfigure/src/main/java/io/opentelemetry/sdk/autoconfigure/MetricExporterConfiguration.java b/sdk-extensions/autoconfigure/src/main/java/io/opentelemetry/sdk/autoconfigure/MetricExporterConfiguration.java index eed123d0d15..cb9411eeb7f 100644 --- a/sdk-extensions/autoconfigure/src/main/java/io/opentelemetry/sdk/autoconfigure/MetricExporterConfiguration.java +++ b/sdk-extensions/autoconfigure/src/main/java/io/opentelemetry/sdk/autoconfigure/MetricExporterConfiguration.java @@ -37,15 +37,16 @@ static MetricReader configureReader( BiFunction metricExporterCustomizer) { if (name.equals("prometheus")) { - if (!ClasspathUtil.checkClassExists( - "io.opentelemetry.exporter.prometheus.PrometheusHttpServer")) { - // PrometheusHttpServer is implemented as MetricReader (not MetricExporter) and uses - // the AutoConfigurationCustomizer#addMeterProviderCustomizer SPI hook instead of - // ConfigurableMetricExporterProvider. While the prometheus SPI hook is not handled here, - // the classpath check here provides uniform exception messages. + // PrometheusHttpServer is implemented as MetricReader (not MetricExporter) and uses + // the AutoConfigurationCustomizer#addMeterProviderCustomizer SPI hook instead of + // ConfigurableMetricExporterProvider. While the prometheus SPI hook is not handled here, + // the classpath check here provides uniform exception messages. + try { + Class.forName("io.opentelemetry.exporter.prometheus.PrometheusHttpServer"); + return null; + } catch (ClassNotFoundException unused) { throw missingExporterException("prometheus", "opentelemetry-exporter-prometheus"); } - return null; } NamedSpiManager spiExportersManager =