Configurable SdkMeterProvider #4

Author: andrus

RELEASE-NOTES.md

@@ -3,4 +3,5 @@
 * #1 OpenTelemetry bootstrap
 * #2 Configurable SdkTracerProvider
 * #3 Injectable OTel Resource with Bootique application name
+* #4 Configurable SdkMeterProvider
 

bootique-opentelemetry/src/main/java/io/bootique/otel/OpenTelemetryFactory.java

@@ -20,24 +20,27 @@
 
 import io.bootique.annotation.BQConfig;
 import io.bootique.annotation.BQConfigProperty;
+import io.bootique.otel.meter.SdkMeterProviderFactory;
 import io.bootique.otel.trace.SdkTracerProviderFactory;
 import io.bootique.shutdown.ShutdownManager;
 import io.opentelemetry.api.OpenTelemetry;
 import io.opentelemetry.sdk.OpenTelemetrySdk;
-import io.opentelemetry.sdk.OpenTelemetrySdkBuilder;
+import io.opentelemetry.sdk.metrics.SdkMeterProvider;
 import io.opentelemetry.sdk.resources.Resource;
+import io.opentelemetry.sdk.trace.SdkTracerProvider;
 import jakarta.inject.Inject;
 
 /**
  * @since 4.0
  */
 @BQConfig
 public class OpenTelemetryFactory {
-    
+
     private final Resource resource;
     private final ShutdownManager shutdownManager;
 
-    private SdkTracerProviderFactory traceProvider;
+    private SdkMeterProviderFactory meterProvider;
+    private SdkTracerProviderFactory tracerProvider;
 
     @Inject
     public OpenTelemetryFactory(Resource resource, ShutdownManager shutdownManager) {
@@ -46,20 +49,37 @@ public OpenTelemetryFactory(Resource resource, ShutdownManager shutdownManager)
     }
 
     @BQConfigProperty
-    public OpenTelemetryFactory setTraceProvider(SdkTracerProviderFactory traceProvider) {
-        this.traceProvider = traceProvider;
+    public OpenTelemetryFactory setMeterProvider(SdkMeterProviderFactory meterProvider) {
+        this.meterProvider = meterProvider;
+        return this;
+    }
+
+    @BQConfigProperty
+    public OpenTelemetryFactory setTracerProvider(SdkTracerProviderFactory tracerProvider) {
+        this.tracerProvider = tracerProvider;
         return this;
     }
 
     public OpenTelemetry create() {
-        OpenTelemetrySdkBuilder builder = OpenTelemetrySdk.builder();
-        builder.setTracerProvider(traceProviderOrDefault().create());
-        return builder.build();
+        SdkMeterProvider meterProvider = meterProviderOrDefault().create();
+        SdkTracerProvider tracerProvider = traceProviderOrDefault().create(meterProvider);
+
+        return OpenTelemetrySdk
+                .builder()
+                .setTracerProvider(tracerProvider)
+                .setMeterProvider(meterProvider)
+                .build();
+    }
+
+    private SdkMeterProviderFactory meterProviderOrDefault() {
+        return meterProvider != null
+                ? meterProvider
+                : new SdkMeterProviderFactory(resource, shutdownManager);
     }
 
     private SdkTracerProviderFactory traceProviderOrDefault() {
-        return traceProvider != null
-                ? traceProvider
+        return tracerProvider != null
+                ? tracerProvider
                 : new SdkTracerProviderFactory(resource, shutdownManager);
     }
 }

bootique-opentelemetry/src/main/java/io/bootique/otel/OpenTelemetryVar.java

@@ -33,11 +33,15 @@ enum OpenTelemetryVar {
 
     /* Exporter Selection */
     OTEL_TRACES_EXPORTER("traces.exporter"),
+    OTEL_METRICS_EXPORTER("metrics.exporter"),
 
     /* OTLP Exporter */
-    OTEL_EXPORTER_OTLP_PROTOCOL("exporter.otlp.protocol");
+    OTEL_EXPORTER_OTLP_PROTOCOL("exporter.otlp.protocol"),
     // TODO: OTEL_EXPORTER_OTLP_TRACES_PROTOCOL, OTEL_EXPORTER_OTLP_METRICS_PROTOCOL, OTEL_EXPORTER_OTLP_LOGS_PROTOCOL
 
+    /* Metrics SDK Configuration */
+    OTEL_METRIC_EXPORT_INTERVAL("metric.export.interval");
+
     public final String otelProperty;
 
     OpenTelemetryVar(String otelProperty) {

bootique-opentelemetry/src/main/java/io/bootique/otel/meter/ConsoleMetricExporterFactory.java

@@ -0,0 +1,35 @@
+/*
+ * Licensed to ObjectStyle LLC under one
+ * or more contributor license agreements.  See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership.  The ObjectStyle LLC licenses
+ * this file to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License.  You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied.  See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+package io.bootique.otel.meter;
+
+import com.fasterxml.jackson.annotation.JsonTypeName;
+import io.opentelemetry.exporter.logging.LoggingMetricExporter;
+import io.opentelemetry.sdk.metrics.export.MetricExporter;
+
+/**
+ * @since 4.0
+ */
+@JsonTypeName("console")
+public class ConsoleMetricExporterFactory implements MetricExporterFactory {
+
+    @Override
+    public MetricExporter create() {
+        return LoggingMetricExporter.create();
+    }
+}

bootique-opentelemetry/src/main/java/io/bootique/otel/meter/MetricExporterFactory.java

@@ -0,0 +1,34 @@
+/*
+ * Licensed to ObjectStyle LLC under one
+ * or more contributor license agreements.  See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership.  The ObjectStyle LLC licenses
+ * this file to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License.  You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied.  See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+package io.bootique.otel.meter;
+
+import com.fasterxml.jackson.annotation.JsonTypeInfo;
+import io.bootique.annotation.BQConfig;
+import io.bootique.config.PolymorphicConfiguration;
+import io.opentelemetry.sdk.metrics.export.MetricExporter;
+
+/**
+ * @since 4.0
+ */
+@BQConfig
+@JsonTypeInfo(use = JsonTypeInfo.Id.NAME, property = "type", defaultImpl = ConsoleMetricExporterFactory.class)
+public interface MetricExporterFactory extends PolymorphicConfiguration {
+
+    MetricExporter create();
+}

bootique-opentelemetry/src/main/java/io/bootique/otel/meter/NoopMetricExporterFactory.java

@@ -0,0 +1,34 @@
+/*
+ * Licensed to ObjectStyle LLC under one
+ * or more contributor license agreements.  See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership.  The ObjectStyle LLC licenses
+ * this file to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License.  You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied.  See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+package io.bootique.otel.meter;
+
+import com.fasterxml.jackson.annotation.JsonTypeName;
+import io.opentelemetry.sdk.metrics.export.MetricExporter;
+
+/**
+ * @since 4.0
+ */
+@JsonTypeName("noop")
+public class NoopMetricExporterFactory implements MetricExporterFactory {
+
+    @Override
+    public MetricExporter create() {
+        return null;
+    }
+}

bootique-opentelemetry/src/main/java/io/bootique/otel/meter/SdkMeterProviderFactory.java

@@ -0,0 +1,114 @@
+/*
+ * Licensed to ObjectStyle LLC under one
+ * or more contributor license agreements.  See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership.  The ObjectStyle LLC licenses
+ * this file to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License.  You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied.  See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+package io.bootique.otel.meter;
+
+import io.bootique.annotation.BQConfig;
+import io.bootique.annotation.BQConfigProperty;
+import io.bootique.shutdown.ShutdownManager;
+import io.bootique.value.Duration;
+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 io.opentelemetry.sdk.metrics.export.PeriodicMetricReader;
+import io.opentelemetry.sdk.resources.Resource;
+import jakarta.inject.Inject;
+
+import java.util.List;
+import java.util.Objects;
+
+/**
+ * @since 4.0
+ */
+@BQConfig
+public class SdkMeterProviderFactory {
+
+    private final Resource resource;
+    private final ShutdownManager shutdownManager;
+
+    private Duration metricExportInterval;
+    private List<MetricExporterFactory> metricExporters;
+
+
+    @Inject
+    public SdkMeterProviderFactory(Resource resource, ShutdownManager shutdownManager) {
+        this.resource = resource;
+        this.shutdownManager = shutdownManager;
+    }
+
+    @BQConfigProperty("Time interval between the start of two export attempts. The default is '1min'")
+    public SdkMeterProviderFactory setMetricExportInterval(Duration metricExportInterval) {
+        this.metricExportInterval = metricExportInterval;
+        return this;
+    }
+
+    @BQConfigProperty
+    public SdkMeterProviderFactory setMetricExporters(List<MetricExporterFactory> metricExporters) {
+        this.metricExporters = metricExporters;
+        return this;
+    }
+
+    public SdkMeterProvider create() {
+        SdkMeterProviderBuilder builder = SdkMeterProvider
+                .builder()
+                .setResource(resource);
+
+        // TODO:
+        //   views
+        //   clock
+        //   exemplar filter
+
+        createMetricReaders().forEach(builder::registerMetricReader);
+        return shutdownManager.onShutdown(builder.build());
+    }
+
+    private List<MetricReader> createMetricReaders() {
+        return createMetricExporters().stream().map(this::createMetricReader).toList();
+    }
+
+    private List<MetricExporter> createMetricExporters() {
+
+        // unlike the agent whose default is "otlp", our default will be "console", so that the app could
+        // work standalone out of the box. To suppress exporting, an explicit "none" exporter should be set
+
+        // A single "none" exporter would suppress the default "console" exporter. Though unlike the agent, having a
+        // "none" exporter mixed with others doesn't result in an exception. It will just be ignored
+
+        List<MetricExporterFactory> exporters = this.metricExporters == null || this.metricExporters.isEmpty()
+                ? List.of(new ConsoleMetricExporterFactory())
+                : this.metricExporters;
+
+        return exporters.stream()
+                .map(MetricExporterFactory::create)
+                .filter(Objects::nonNull)
+                .toList();
+    }
+
+    private MetricReader createMetricReader(MetricExporter exporter) {
+        return PeriodicMetricReader.builder(exporter)
+                .setInterval(getMetricExportIntervalOrDefault())
+                .build();
+    }
+
+    private java.time.Duration getMetricExportIntervalOrDefault() {
+        return this.metricExportInterval != null
+                ? this.metricExportInterval.getDuration()
+                : java.time.Duration.ofMinutes(1);
+    }
+}

bootique-opentelemetry/src/main/java/io/bootique/otel/trace/ConsoleSpanExporterFactory.java

@@ -25,7 +25,7 @@
 public class ConsoleSpanExporterFactory implements SpanExporterFactory {
 
     @Override
-    public SpanExporterSupplier create() {
-        return new SpanExporterSupplier(() -> LoggingSpanExporter.create(), false);
+    public SpanExporterHolder create() {
+        return new SpanExporterHolder(LoggingSpanExporter::create, false);
     }
 }

bootique-opentelemetry/src/main/java/io/bootique/otel/trace/NoneSpanExporterFactory.java

@@ -24,7 +24,7 @@
 public class NoneSpanExporterFactory implements SpanExporterFactory {
 
     @Override
-    public SpanExporterSupplier create() {
-        return new SpanExporterSupplier(null, false);
+    public SpanExporterHolder create() {
+        return null;
     }
 }