Initial Observability extension - devservices, devresources, LGTM

Grafana OTel LGTM additional Documentation Fix enforcer configuration and make names consistent Update descriptors with latest dependency state Abstract Testcontainers usage, own Container SPI.
quarkusio · Apr 17, 2024 · 5b033cc · 5b033cc
1 parent 1e73223
commit 5b033cc
Show file tree

Hide file tree

Showing 62 changed files with 2,631 additions and 5 deletions.
diff --git a/bom/application/pom.xml b/bom/application/pom.xml
@@ -226,6 +226,8 @@
         <mutiny-zero.version>1.1.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>
@@ -490,6 +492,18 @@
                 <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>
@@ -2991,6 +3005,42 @@
                 <artifactId>quarkus-virtual-threads-deployment</artifactId>
                 <version>${project.version}</version>
             </dependency>
+            <dependency>
+                <groupId>io.quarkus</groupId>
+                <artifactId>quarkus-observability-devservices-common</artifactId>
+                <version>${project.version}</version>
+            </dependency>
+            <dependency>
+                <groupId>io.quarkus</groupId>
+                <artifactId>quarkus-observability-devservices</artifactId>
+                <version>${project.version}</version>
+            </dependency>
+            <dependency>
+                <groupId>io.quarkus</groupId>
+                <artifactId>quarkus-observability-devservices-lgtm</artifactId>
+                <version>${project.version}</version>
+                <scope>provided</scope>
+            </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-common</artifactId>
+                <version>${project.version}</version>
+            </dependency>
+            <dependency>
+                <groupId>io.quarkus</groupId>
+                <artifactId>quarkus-observability-devresource-testcontainers</artifactId>
+                <version>${project.version}</version>
+            </dependency>
+            <dependency>
+                <groupId>io.quarkus</groupId>
+                <artifactId>quarkus-observability-devresource-lgtm</artifactId>
+                <version>${project.version}</version>
+            </dependency>
 
             <!-- Quarkus test dependencies -->
             <dependency>

diff --git a/core/deployment/src/main/java/io/quarkus/deployment/Feature.java b/core/deployment/src/main/java/io/quarkus/deployment/Feature.java
@@ -69,6 +69,7 @@ public enum Feature {
     NARAYANA_LRA,
     NARAYANA_STM,
     NEO4J,
+    OBSERVABILITY,
     OIDC,
     OIDC_CLIENT,
     RESTEASY_CLIENT_OIDC_FILTER,

diff --git a/core/deployment/src/main/java/io/quarkus/deployment/console/StartupLogCompressor.java b/core/deployment/src/main/java/io/quarkus/deployment/console/StartupLogCompressor.java
@@ -3,6 +3,7 @@
 import java.io.Closeable;
 import java.util.ArrayList;
 import java.util.List;
+import java.util.Objects;
 import java.util.Optional;
 import java.util.concurrent.atomic.AtomicInteger;
 import java.util.function.BiPredicate;
@@ -26,18 +27,28 @@ public class StartupLogCompressor implements Closeable, BiPredicate<String, Bool
     final List<String> toDump = new ArrayList<>();
     final AtomicInteger COUNTER = new AtomicInteger();
     final Predicate<Thread> additionalThreadPredicate;
+    final Predicate<String> linePredicate; // test if we always print the line / log
 
     public StartupLogCompressor(String name,
             @SuppressWarnings("unused") Optional<ConsoleInstalledBuildItem> consoleInstalledBuildItem,
             @SuppressWarnings("unused") LoggingSetupBuildItem loggingSetupBuildItem) {
-        this(name, consoleInstalledBuildItem, loggingSetupBuildItem, (s) -> false);
+        this(name, consoleInstalledBuildItem, loggingSetupBuildItem, s -> false);
     }
 
     public StartupLogCompressor(String name,
             @SuppressWarnings("unused") Optional<ConsoleInstalledBuildItem> consoleInstalledBuildItem,
             @SuppressWarnings("unused") LoggingSetupBuildItem loggingSetupBuildItem,
             Predicate<Thread> additionalThreadPredicate) {
-        this.additionalThreadPredicate = additionalThreadPredicate;
+        this(name, consoleInstalledBuildItem, loggingSetupBuildItem, additionalThreadPredicate, s -> false);
+    }
+
+    public StartupLogCompressor(String name,
+            @SuppressWarnings("unused") Optional<ConsoleInstalledBuildItem> consoleInstalledBuildItem,
+            @SuppressWarnings("unused") LoggingSetupBuildItem loggingSetupBuildItem,
+            Predicate<Thread> additionalThreadPredicate,
+            Predicate<String> linePredicate) {
+        this.additionalThreadPredicate = Objects.requireNonNull(additionalThreadPredicate);
+        this.linePredicate = Objects.requireNonNull(linePredicate);
         if (QuarkusConsole.INSTANCE.isAnsiSupported()) {
             QuarkusConsole.installRedirects();
             this.name = name;
@@ -74,8 +85,8 @@ public void closeAndDumpCaptured() {
 
     @Override
     public boolean test(String s, Boolean errorStream) {
-        if (thread == null) {
-            //not installed
+        if (thread == null || linePredicate.test(s)) {
+            //not installed or line predicate tested to true
             return true;
         }
         Thread current = Thread.currentThread();

diff --git a/core/runtime/src/main/java/io/quarkus/runtime/util/EnumerationUtil.java b/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());
+    }
+}
diff --git a/devtools/bom-descriptor-json/pom.xml b/devtools/bom-descriptor-json/pom.xml
@@ -1591,6 +1591,19 @@
                         </exclusion>
                     </exclusions>
                 </dependency>
+                <dependency>
+                    <groupId>io.quarkus</groupId>
+                    <artifactId>quarkus-observability-devservices</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>

diff --git a/docs/pom.xml b/docs/pom.xml
@@ -1607,6 +1607,19 @@
                 </exclusion>
             </exclusions>
         </dependency>
+        <dependency>
+            <groupId>io.quarkus</groupId>
+            <artifactId>quarkus-observability-devservices-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>

diff --git a/docs/src/main/asciidoc/dev-services.adoc b/docs/src/main/asciidoc/dev-services.adoc
@@ -165,6 +165,14 @@ More information can be found in the xref:elasticsearch-dev-services.adoc[Elasti
 
 include::{generated-dir}/config/quarkus-elasticsearch-devservices-elasticsearch-dev-services-build-time-config.adoc[opts=optional, leveloffset=+1]
 
+=== Observability
+
+The Observability Dev Services will be enabled when the `quarkus-observability-devservices` extension is present in your application, and
+there is at least one dev resource on the classpath. More information can be found in the
+xref:observability-devservices.adoc[Observability Dev Services Guide].
+
+include::{generated-dir}/config/quarkus-observability-config-observability-configuration.adoc[opts=optional, leveloffset=+1]
+
 == Dev Services beyond the Quarkus Platform
 
 Many Quarkiverse extensions which are not in the Quarkus Platform also offer Dev Services.