Initial Observability extension - PromQL client, devservices, etc

bom/application/pom.xml

@@ -226,6 +226,8 @@
         <mutiny-zero.version>1.0.0</mutiny-zero.version>
         <pulsar-client.version>3.0.0</pulsar-client.version>
         <async-http-client.version>2.12.3</async-http-client.version>
+        <!-- keep in-sync, if possible, with Micrometer registry Prometheus -->
+        <prometheus.version>0.16.0</prometheus.version>
         <!-- Dev UI -->
         <importmap.version>1.0.10</importmap.version>
     </properties>
@@ -472,6 +474,19 @@
                 <scope>import</scope>
             </dependency>
 
+            <!-- Prometheus -->
+            <dependency>
+                <groupId>io.prometheus</groupId>
+                <artifactId>simpleclient</artifactId>
+                <version>${prometheus.version}</version>
+            </dependency>
+            <dependency>
+                <groupId>io.prometheus</groupId>
+                <artifactId>simpleclient_common</artifactId>
+                <version>${prometheus.version}</version>
+            </dependency>
+
+
             <!-- Quarkus core -->
 
             <dependency>
@@ -2953,6 +2968,66 @@
                 <artifactId>quarkus-virtual-threads-deployment</artifactId>
                 <version>${project.version}</version>
             </dependency>
+            <dependency>
+                <groupId>io.quarkus</groupId>
+                <artifactId>quarkus-observability-common</artifactId>
+                <version>${project.version}</version>
+            </dependency>
+            <dependency>
+                <groupId>io.quarkus</groupId>
+                <artifactId>quarkus-observability</artifactId>
+                <version>${project.version}</version>
+            </dependency>
+            <dependency>
+                <groupId>io.quarkus</groupId>
+                <artifactId>quarkus-observability-promql</artifactId>
+                <version>${project.version}</version>
+            </dependency>
+            <dependency>
+                <groupId>io.quarkus</groupId>
+                <artifactId>quarkus-observability-victoriametrics</artifactId>
+                <version>${project.version}</version>
+            </dependency>
+            <dependency>
+                <groupId>io.quarkus</groupId>
+                <artifactId>quarkus-observability-testlibs</artifactId>
+                <version>${project.version}</version>
+            </dependency>
+            <dependency>
+                <groupId>io.quarkus</groupId>
+                <artifactId>quarkus-observability-testcontainers</artifactId>
+                <version>${project.version}</version>
+            </dependency>
+            <dependency>
+                <groupId>io.quarkus</groupId>
+                <artifactId>quarkus-observability-devresource</artifactId>
+                <version>${project.version}</version>
+            </dependency>
+            <dependency>
+                <groupId>io.quarkus</groupId>
+                <artifactId>quarkus-observability-devresource-victoriametrics</artifactId>
+                <version>${project.version}</version>
+            </dependency>
+            <dependency>
+                <groupId>io.quarkus</groupId>
+                <artifactId>quarkus-observability-devresource-vmagent</artifactId>
+                <version>${project.version}</version>
+            </dependency>
+            <dependency>
+                <groupId>io.quarkus</groupId>
+                <artifactId>quarkus-observability-devresource-grafana</artifactId>
+                <version>${project.version}</version>
+            </dependency>
+            <dependency>
+                <groupId>io.quarkus</groupId>
+                <artifactId>quarkus-observability-devresource-otel-collector</artifactId>
+                <version>${project.version}</version>
+            </dependency>
+            <dependency>
+                <groupId>io.quarkus</groupId>
+                <artifactId>quarkus-observability-devresource-jaeger</artifactId>
+                <version>${project.version}</version>
+            </dependency>
 
             <!-- Quarkus test dependencies -->
             <dependency>

core/deployment/src/main/java/io/quarkus/deployment/Feature.java

@@ -68,6 +68,7 @@ public enum Feature {
     NARAYANA_LRA,
     NARAYANA_STM,
     NEO4J,
+    OBSERVABILITY,
     OIDC,
     OIDC_CLIENT,
     OIDC_CLIENT_FILTER,

core/runtime/src/main/java/io/quarkus/runtime/util/EnumerationUtil.java

@@ -0,0 +1,69 @@
+package io.quarkus.runtime.util;
+
+import java.util.Enumeration;
+import java.util.Iterator;
+import java.util.NoSuchElementException;
+import java.util.Objects;
+import java.util.Spliterator;
+import java.util.function.Consumer;
+import java.util.stream.Stream;
+
+/**
+ * Transform to "old school" Enumeration from Iterator/Spliterator/Stream
+ */
+public class EnumerationUtil {
+    public static <T> Enumeration<T> from(Iterator<T> iterator) {
+        Objects.requireNonNull(iterator);
+
+        return new Enumeration<T>() {
+            @Override
+            public boolean hasMoreElements() {
+                return iterator.hasNext();
+            }
+
+            @Override
+            public T nextElement() {
+                return iterator.next();
+            }
+        };
+    }
+
+    public static <T> Enumeration<T> from(Spliterator<T> spliterator) {
+        Objects.requireNonNull(spliterator);
+
+        class Adapter implements Enumeration<T>, Consumer<T> {
+            boolean valueReady;
+            T nextElement;
+
+            public void accept(T t) {
+                this.valueReady = true;
+                this.nextElement = t;
+            }
+
+            public boolean hasMoreElements() {
+                if (!this.valueReady) {
+                    spliterator.tryAdvance(this);
+                }
+
+                return this.valueReady;
+            }
+
+            public T nextElement() {
+                if (!this.valueReady && !this.hasMoreElements()) {
+                    throw new NoSuchElementException();
+                } else {
+                    this.valueReady = false;
+                    T t = this.nextElement;
+                    this.nextElement = null;
+                    return t;
+                }
+            }
+        }
+
+        return new Adapter();
+    }
+
+    public static <T> Enumeration<T> from(Stream<T> stream) {
+        return from(stream.spliterator());
+    }
+}

devtools/bom-descriptor-json/pom.xml

@@ -1526,6 +1526,19 @@
                         </exclusion>
                     </exclusions>
                 </dependency>
+                <dependency>
+                    <groupId>io.quarkus</groupId>
+                    <artifactId>quarkus-observability</artifactId>
+                    <version>${project.version}</version>
+                    <type>pom</type>
+                    <scope>test</scope>
+                    <exclusions>
+                        <exclusion>
+                            <groupId>*</groupId>
+                            <artifactId>*</artifactId>
+                        </exclusion>
+                    </exclusions>
+                </dependency>
                 <dependency>
                     <groupId>io.quarkus</groupId>
                     <artifactId>quarkus-oidc</artifactId>

docs/pom.xml

@@ -1542,6 +1542,19 @@
                 </exclusion>
             </exclusions>
         </dependency>
+        <dependency>
+            <groupId>io.quarkus</groupId>
+            <artifactId>quarkus-observability-deployment</artifactId>
+            <version>${project.version}</version>
+            <type>pom</type>
+            <scope>test</scope>
+            <exclusions>
+                <exclusion>
+                    <groupId>*</groupId>
+                    <artifactId>*</artifactId>
+                </exclusion>
+            </exclusions>
+        </dependency>
         <dependency>
             <groupId>io.quarkus</groupId>
             <artifactId>quarkus-oidc-deployment</artifactId>

extensions/devservices/common/src/main/java/io/quarkus/devservices/common/ContainerLocator.java

@@ -1,7 +1,9 @@
 package io.quarkus.devservices.common;
 
 import java.util.Arrays;
+import java.util.Objects;
 import java.util.Optional;
+import java.util.function.BiConsumer;
 import java.util.function.BiPredicate;
 
 import org.jboss.logging.Logger;
@@ -61,6 +63,30 @@ public Optional<ContainerAddress> locateContainer(String serviceName, boolean sh
         }
     }
 
+    /**
+     * @return container id, if exists
+     */
+    public Optional<String> locateContainer(String serviceName, boolean shared, LaunchMode launchMode,
+            BiConsumer<Integer, ContainerAddress> consumer) {
+        if (shared && launchMode == LaunchMode.DEVELOPMENT) {
+            return lookup(serviceName)
+                    .map(container -> {
+                        Arrays.stream(container.getPorts())
+                                .filter(cp -> Objects.nonNull(cp.getPublicPort()) && Objects.nonNull(cp.getPrivatePort()))
+                                .forEach(cp -> {
+                                    ContainerAddress containerAddress = new ContainerAddress(
+                                            container.getId(),
+                                            DockerClientFactory.instance().dockerHostIpAddress(),
+                                            cp.getPublicPort());
+                                    consumer.accept(cp.getPrivatePort(), containerAddress);
+                                });
+                        return container.getId();
+                    });
+        } else {
+            return Optional.empty();
+        }
+    }
+
     public Optional<Integer> locatePublicPort(String serviceName, boolean shared, LaunchMode launchMode, int privatePort) {
         if (shared && launchMode == LaunchMode.DEVELOPMENT) {
             return lookup(serviceName)

extensions/observability/common/pom.xml

@@ -0,0 +1,27 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project xmlns="http://maven.apache.org/POM/4.0.0"
+         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
+    <modelVersion>4.0.0</modelVersion>
+    <parent>
+        <artifactId>quarkus-observability-parent</artifactId>
+        <groupId>io.quarkus</groupId>
+        <version>999-SNAPSHOT</version>
+    </parent>
+
+    <artifactId>quarkus-observability-common</artifactId>
+    <name>Quarkus - Observability - Common</name>
+
+    <dependencies>
+        <dependency>
+            <groupId>io.quarkus</groupId>
+            <artifactId>quarkus-core</artifactId>
+            <scope>provided</scope>
+        </dependency>
+        <dependency>
+            <groupId>io.smallrye.config</groupId>
+            <artifactId>smallrye-config-core</artifactId>
+            <scope>provided</scope>
+        </dependency>
+    </dependencies>
+</project>

extensions/observability/common/src/main/java/io/quarkus/observability/common/ContainerConstants.java

@@ -0,0 +1,10 @@
+package io.quarkus.observability.common;
+
+public final class ContainerConstants {
+
+    public static final String GRAFANA = "grafana/grafana:10.1.0";
+    public static final String JAEGER = "quay.io/jaegertracing/all-in-one:1.48.0";
+    public static final String OTEL = "otel/opentelemetry-collector-contrib:0.83.0";
+    public static final String VICTORIA_METRICS = "victoriametrics/victoria-metrics:v1.93.0";
+    public static final String VM_AGENT = "victoriametrics/vmagent:v1.93.0";
+}

extensions/observability/common/src/main/java/io/quarkus/observability/common/config/AbstractContainerConfig.java

@@ -0,0 +1,51 @@
+package io.quarkus.observability.common.config;
+
+import java.util.Locale;
+import java.util.Optional;
+import java.util.Set;
+
+public abstract class AbstractContainerConfig implements ContainerConfig {
+
+    private final String imageName;
+    private final boolean shared;
+
+    public AbstractContainerConfig(String imageName) {
+        this(imageName, true);
+    }
+
+    public AbstractContainerConfig(String imageName, boolean shared) {
+        this.imageName = imageName;
+        this.shared = shared;
+    }
+
+    @Override
+    public boolean enabled() {
+        return true;
+    }
+
+    @Override
+    public String imageName() {
+        return imageName;
+    }
+
+    @Override
+    public boolean shared() {
+        return shared;
+    }
+
+    @Override
+    public Optional<Set<String>> networkAliases() {
+        return Optional.empty();
+    }
+
+    @Override
+    public String label() {
+        String sn = getClass().getSimpleName().toLowerCase(Locale.ROOT);
+        return "quarkus-dev-resource-" + sn;
+    }
+
+    @Override
+    public String serviceName() {
+        return "quarkus";
+    }
+}

extensions/observability/common/src/main/java/io/quarkus/observability/common/config/ConfigUtils.java

@@ -0,0 +1,26 @@
+package io.quarkus.observability.common.config;
+
+public class ConfigUtils {
+
+    public static boolean isEnabled(ContainerConfig config) {
+        if (config != null && config.enabled()) {
+            DevTarget target = config.getClass().getAnnotation(DevTarget.class);
+            if (target != null) {
+                ClassLoader cl = Thread.currentThread().getContextClassLoader();
+                try {
+                    cl.loadClass(target.value());
+                    return true;
+                } catch (ClassNotFoundException ignore) {
+                }
+            }
+        }
+        return false;
+    }
+
+    public static String vmEndpoint(VictoriaMetricsConfig vmc) {
+        String host = vmc.networkAliases().map(s -> s.iterator().next()).orElse("victoria-metrics");
+        int port = vmc.port();
+        return String.format("%s:%s", host, port);
+    }
+
+}