Observability Dev UI Card and Log Console

quarkusio · Jun 26, 2024 · 42616ae · 42616ae
1 parent 0927ceb
commit 42616ae
Show file tree

Hide file tree

Showing 10 changed files with 330 additions and 1 deletion.
diff --git a/extensions/observability-devservices/deployment/pom.xml b/extensions/observability-devservices/deployment/pom.xml
@@ -29,6 +29,15 @@
             <groupId>io.quarkus</groupId>
             <artifactId>quarkus-observability-devservices</artifactId>
         </dependency>
+        <dependency>
+            <groupId>io.quarkus</groupId>
+            <artifactId>quarkus-vertx-http-deployment</artifactId>
+        </dependency>
+        <dependency>
+            <groupId>io.quarkus</groupId>
+            <artifactId>quarkus-vertx-http-dev-ui-spi</artifactId>
+            <optional>true</optional>
+        </dependency>
 
         <dependency>
             <groupId>io.quarkus</groupId>

diff --git a/...t/src/main/java/io/quarkus/observability/deployment/ObservabilityDevServiceProcessor.java b/...t/src/main/java/io/quarkus/observability/deployment/ObservabilityDevServiceProcessor.java
@@ -32,6 +32,7 @@
 import io.quarkus.observability.common.config.ContainerConfig;
 import io.quarkus.observability.common.config.ContainerConfigUtil;
 import io.quarkus.observability.common.config.ModulesConfiguration;
+import io.quarkus.observability.deployment.devui.ObservabilityDevServicesConfigBuildItem;
 import io.quarkus.observability.devresource.Container;
 import io.quarkus.observability.devresource.DevResourceLifecycleManager;
 import io.quarkus.observability.devresource.DevResources;
@@ -74,7 +75,8 @@ public void startContainers(LaunchModeBuildItem launchMode,
             CuratedApplicationShutdownBuildItem closeBuildItem,
             LoggingSetupBuildItem loggingSetupBuildItem,
             GlobalDevServicesConfig devServicesConfig,
-            BuildProducer<DevServicesResultBuildItem> services) {
+            BuildProducer<DevServicesResultBuildItem> services,
+            BuildProducer<ObservabilityDevServicesConfigBuildItem> configBuildProducer) {
 
         if (!configuration.enabled()) {
             log.infof("Observability dev services are disabled in config");
@@ -146,6 +148,7 @@ public void startContainers(LaunchModeBuildItem launchMode,
 
                 devService = newDevService;
                 devServices.put(devId, newDevService);
+                configBuildProducer.produce(new ObservabilityDevServicesConfigBuildItem(newDevService.getConfig()));
             } catch (Throwable t) {
                 compressor.closeAndDumpCaptured();
                 throw new RuntimeException(t);

diff --git a/...va/io/quarkus/observability/deployment/devui/ObservabilityDevServicesConfigBuildItem.java b/...va/io/quarkus/observability/deployment/devui/ObservabilityDevServicesConfigBuildItem.java
@@ -0,0 +1,22 @@
+package io.quarkus.observability.deployment.devui;
+
+import java.util.Map;
+
+import io.quarkus.builder.item.SimpleBuildItem;
+
+/**
+ * Build item used to carry running DevService values to Dev UI.
+ */
+public final class ObservabilityDevServicesConfigBuildItem extends SimpleBuildItem {
+
+    private final Map<String, String> config;
+
+    public ObservabilityDevServicesConfigBuildItem(Map<String, String> config) {
+        this.config = config;
+    }
+
+    public Map<String, String> getConfig() {
+        return config;
+    }
+
+}
diff --git a/.../src/main/java/io/quarkus/observability/deployment/devui/ObservabilityDevUIProcessor.java b/.../src/main/java/io/quarkus/observability/deployment/devui/ObservabilityDevUIProcessor.java
@@ -0,0 +1,70 @@
+package io.quarkus.observability.deployment.devui;
+
+import java.util.Map;
+import java.util.Optional;
+
+import org.apache.commons.lang3.StringUtils;
+
+import io.quarkus.deployment.IsDevelopment;
+import io.quarkus.deployment.IsNormal;
+import io.quarkus.deployment.annotations.BuildProducer;
+import io.quarkus.deployment.annotations.BuildStep;
+import io.quarkus.deployment.annotations.BuildSteps;
+import io.quarkus.deployment.dev.devservices.GlobalDevServicesConfig;
+import io.quarkus.devui.spi.page.CardPageBuildItem;
+import io.quarkus.devui.spi.page.ExternalPageBuilder;
+import io.quarkus.devui.spi.page.FooterPageBuildItem;
+import io.quarkus.devui.spi.page.Page;
+import io.quarkus.devui.spi.page.WebComponentPageBuilder;
+
+/**
+ * Dev UI card for displaying important details such LGTM embedded UI.
+ */
+@BuildSteps(onlyIfNot = IsNormal.class, onlyIf = { GlobalDevServicesConfig.Enabled.class })
+public class ObservabilityDevUIProcessor {
+
+    @BuildStep(onlyIf = IsDevelopment.class)
+    void createVersion(BuildProducer<CardPageBuildItem> cardPageBuildItemBuildProducer,
+            BuildProducer<FooterPageBuildItem> footerProducer,
+            Optional<ObservabilityDevServicesConfigBuildItem> configProps) {
+
+        // LGTM
+        if (configProps.isPresent()) {
+            Map<String, String> runtimeConfig = configProps.get().getConfig();
+            String grafanaUrl = runtimeConfig.getOrDefault("grafana.endpoint", "");
+
+            if (StringUtils.isNotEmpty(grafanaUrl)) {
+                final CardPageBuildItem card = new CardPageBuildItem();
+
+                // Grafana
+                grafanaUrl = StringUtils.prependIfMissing(grafanaUrl, "http://");
+                card.addPage(Page.externalPageBuilder("Grafana UI")
+                        .url(grafanaUrl, grafanaUrl)
+                        .doNotEmbed()
+                        .isHtmlContent()
+                        .icon("font-awesome-solid:chart-line"));
+
+                // Open Telemetry
+                final ExternalPageBuilder otelPage = Page.externalPageBuilder("OpenTelemetry Port")
+                        .icon("font-awesome-solid:binoculars")
+                        .doNotEmbed()
+                        .url("https://opentelemetry.io/")
+                        .staticLabel(StringUtils
+                                .substringAfterLast(runtimeConfig.getOrDefault("otel-collector.url", "0"), ":"));
+                card.addPage(otelPage);
+
+                card.setCustomCard("qwc-lgtm-card.js");
+                cardPageBuildItemBuildProducer.produce(card);
+
+                // LGTM Container Log Console
+                WebComponentPageBuilder mailLogPageBuilder = Page.webComponentPageBuilder()
+                        .icon("font-awesome-solid:chart-line")
+                        .title("LGTM")
+                        .componentLink("qwc-lgtm-log.js");
+
+                footerProducer.produce(new FooterPageBuildItem(mailLogPageBuilder));
+            }
+        }
+
+    }
+}
diff --git a/extensions/observability-devservices/deployment/src/main/resources/dev-ui/qwc-lgtm-card.js b/extensions/observability-devservices/deployment/src/main/resources/dev-ui/qwc-lgtm-card.js
diff --git a/extensions/observability-devservices/deployment/src/main/resources/dev-ui/qwc-lgtm-log.js b/extensions/observability-devservices/deployment/src/main/resources/dev-ui/qwc-lgtm-log.js
@@ -0,0 +1,15 @@
+import { QwcServerLog } from "qwc-server-log";
+
+/**
+ * This component filter the log to only show LGTM related entries.
+ */
+export class QwcLgtmLog extends QwcServerLog {
+  doLogEntry(entry) {
+    if (entry.loggerName && entry.loggerName.includes("LgtmContainer")) {
+      return true;
+    }
+    return false;
+  }
+}
+
+customElements.define("qwc-lgtm-log", QwcLgtmLog);
diff --git a/extensions/observability-devservices/runtime/pom.xml b/extensions/observability-devservices/runtime/pom.xml
@@ -21,6 +21,10 @@
             <groupId>io.quarkus</groupId>
             <artifactId>quarkus-core</artifactId>
         </dependency>
+        <dependency>
+            <groupId>io.quarkus</groupId>
+            <artifactId>quarkus-vertx-http</artifactId>
+        </dependency>
 
         <dependency>
             <groupId>io.quarkus</groupId>

diff --git a/...ions/observability-devservices/runtime/src/main/resources/META-INF/quarkus-extension.yaml b/...ions/observability-devservices/runtime/src/main/resources/META-INF/quarkus-extension.yaml
@@ -0,0 +1,19 @@
+name: "Observability"
+artifact: ${project.groupId}:${project.artifactId}:${project.version}
+metadata:
+  keywords:
+    - "lgtm"
+    - "grafana"
+    - "prometheus"
+    - "tempo"
+    - "opentelemetry"
+    - "tracing"
+    - "distributed-tracing"
+    - "monitoring"
+  categories:
+    - "observability"
+  config:
+    - "quarkus.observability."
+  status: "experimental"
+  guide: "https://quarkus.io/guides/observability-devservices"
+  icon-url: "https://upload.wikimedia.org/wikipedia/commons/3/3b/Grafana_icon.svg"
diff --git a/...s/testcontainers/src/main/java/io/quarkus/observability/testcontainers/LgtmContainer.java b/...s/testcontainers/src/main/java/io/quarkus/observability/testcontainers/LgtmContainer.java
@@ -3,11 +3,18 @@
 import java.util.Optional;
 import java.util.Set;
 
+import org.jboss.logging.Logger;
+
 import io.quarkus.observability.common.ContainerConstants;
 import io.quarkus.observability.common.config.AbstractGrafanaConfig;
 import io.quarkus.observability.common.config.LgtmConfig;
 
 public class LgtmContainer extends GrafanaContainer<LgtmContainer, LgtmConfig> {
+    /**
+     * Logger which will be used to capture container STDOUT and STDERR.
+     */
+    private static final Logger log = Logger.getLogger(LgtmContainer.class);
+
     protected static final String LGTM_NETWORK_ALIAS = "ltgm.testcontainer.docker";
 
     public LgtmContainer() {
@@ -17,6 +24,7 @@ public LgtmContainer() {
     public LgtmContainer(LgtmConfig config) {
         super(config);
         addExposedPorts(config.otlpPort());
+        withLogConsumer(new LgtmContainerLogConsumer(log).withPrefix("LGTM"));
     }
 
     public int getOtlpPort() {