SOLR-17937: Adding GPU details to the Admin UI (#3717)

Author: punAhuja

changelog/unreleased/GPU-info-admin-ui.yml

@@ -0,0 +1,6 @@
+# See https://github.com/apache/solr/blob/main/dev-docs/changelog.adoc
+title: Adding GPU details on the Admin UI using OpenTelemetry
+type: added
+authors:
+  - name: Puneet Ahuja
+

gradle/libs.versions.toml

@@ -74,6 +74,7 @@ commons-codec = "1.19.0"
 commons-io = "2.20.0"
 compose = "1.8.2"
 cutterslade-analyze = "1.10.0"
+cuvs-java = "25.10.0"
 cuvs-lucene = "25.10.0"
 cybozulabs-langdetect = "1.1-20120112"
 decompose = "3.3.0"
@@ -319,6 +320,7 @@ codehaus-woodstox-stax2api = { module = "org.codehaus.woodstox:stax2-api", versi
 commonscli-commonscli = { module = "commons-cli:commons-cli", version.ref = "commons-cli" }
 commonscodec-commonscodec = { module = "commons-codec:commons-codec", version.ref = "commons-codec" }
 commonsio-commonsio = { module = "commons-io:commons-io", version.ref = "commons-io" }
+cuvs-java = { module = "com.nvidia.cuvs:cuvs-java", version.ref = "cuvs-java" }
 cuvs-lucene = { module = "com.nvidia.cuvs.lucene:cuvs-lucene", version.ref = "cuvs-lucene" }
 cybozulabs-langdetect = { module = "com.cybozu.labs:langdetect", version.ref = "cybozulabs-langdetect" }
 decompose-decompose = { module = "com.arkivanov.decompose:decompose", version.ref = "decompose" }

solr/core/src/java/org/apache/solr/core/CoreContainer.java

@@ -130,6 +130,7 @@
 import org.apache.solr.jersey.JerseyAppHandlerCache;
 import org.apache.solr.logging.LogWatcher;
 import org.apache.solr.logging.MDCLoggingContext;
+import org.apache.solr.metrics.GpuMetricsProvider;
 import org.apache.solr.metrics.SolrMetricManager;
 import org.apache.solr.metrics.SolrMetricProducer;
 import org.apache.solr.metrics.SolrMetricsContext;
@@ -778,6 +779,9 @@ private void loadInternal() {
 
     solrMetricsContext = new SolrMetricsContext(metricManager, NODE_REGISTRY);
 
+    // Initialize GPU metrics service
+    initGpuMetricsService();
+
     shardHandlerFactory =
         ShardHandlerFactory.newInstance(cfg.getShardHandlerFactoryPluginInfo(), loader);
     if (shardHandlerFactory instanceof SolrMetricProducer metricProducer) {
@@ -1154,6 +1158,59 @@ private static void checkForDuplicateCoreNames(List<CoreDescriptor> cds) {
     }
   }
 
+  private void initGpuMetricsService() {
+    try {
+      Class<?> serviceClass = Class.forName("org.apache.solr.cuvs.GpuMetricsService");
+      Object serviceObj = serviceClass.getMethod("getInstance").invoke(null);
+
+      if (serviceObj instanceof GpuMetricsProvider provider) {
+        serviceClass.getMethod("initialize", CoreContainer.class).invoke(serviceObj, this);
+        provider.initializeMetrics(
+            solrMetricsContext,
+            Attributes.builder()
+                .put(SolrMetricProducer.TYPE_ATTR, "gpu")
+                .put(SolrMetricProducer.CATEGORY_ATTR, "system")
+                .build());
+        log.info("GPU metrics service initialized");
+      }
+    } catch (ClassNotFoundException e) {
+      log.debug("cuVS module not available, GPU metrics will not be collected");
+    } catch (Exception e) {
+      log.warn("Failed to initialize GPU metrics service", e);
+    }
+  }
+
+  private void shutdownGpuMetricsService() {
+    try {
+      Class<?> serviceClass = Class.forName("org.apache.solr.cuvs.GpuMetricsService");
+      Object serviceObj = serviceClass.getMethod("getInstance").invoke(null);
+
+      if (serviceObj instanceof GpuMetricsProvider) {
+        GpuMetricsProvider provider = (GpuMetricsProvider) serviceObj;
+        provider.close();
+        log.info("GPU metrics service shut down");
+      }
+    } catch (ClassNotFoundException e) {
+      // Expected when cuvs module is not available
+    } catch (Exception e) {
+      log.warn("Failed to shutdown GPU metrics service", e);
+    }
+  }
+
+  public GpuMetricsProvider getGpuMetricsProvider() {
+    try {
+      Class<?> serviceClass = Class.forName("org.apache.solr.cuvs.GpuMetricsService");
+      Object serviceObj = serviceClass.getMethod("getInstance").invoke(null);
+
+      if (serviceObj instanceof GpuMetricsProvider) {
+        return (GpuMetricsProvider) serviceObj;
+      }
+    } catch (Exception e) {
+      // Module not available
+    }
+    return null;
+  }
+
   private volatile boolean isShutDown = false;
 
   public boolean isShutDown() {
@@ -1219,6 +1276,9 @@ public void shutdown() {
 
       customThreadPool.execute(replayUpdatesExecutor::shutdownAndAwaitTermination);
 
+      // Shutdown GPU metrics service if it was initialized
+      shutdownGpuMetricsService();
+
       if (metricManager != null) {
         // Close all OTEL meter providers and metrics
         metricManager.closeAllRegistries();

solr/core/src/java/org/apache/solr/handler/admin/SystemInfoHandler.java

@@ -55,6 +55,7 @@
 import org.apache.solr.core.SolrCore;
 import org.apache.solr.handler.RequestHandlerBase;
 import org.apache.solr.handler.admin.api.NodeSystemInfoAPI;
+import org.apache.solr.metrics.GpuMetricsProvider;
 import org.apache.solr.request.SolrQueryRequest;
 import org.apache.solr.response.SolrQueryResponse;
 import org.apache.solr.schema.IndexSchema;
@@ -238,6 +239,8 @@ public void handleRequestBody(SolrQueryRequest req, SolrQueryResponse rsp) throw
     rsp.add("jvm", getJvmInfo(nodeConfig));
     rsp.add("security", getSecurityInfo(req));
     rsp.add("system", getSystemInfo());
+
+    rsp.add("gpu", getGpuInfo(req));
     if (solrCloudMode) {
       rsp.add("node", getCoreContainer(req).getZkController().getNodeName());
     }
@@ -519,6 +522,50 @@ public Boolean registerV2() {
     return Boolean.TRUE;
   }
 
+  private SimpleOrderedMap<Object> getGpuInfo(SolrQueryRequest req) {
+    SimpleOrderedMap<Object> gpuInfo = new SimpleOrderedMap<>();
+
+    try {
+      GpuMetricsProvider provider = getCoreContainer(req).getGpuMetricsProvider();
+
+      if (provider == null) {
+        gpuInfo.add("available", false);
+        return gpuInfo;
+      }
+
+      long gpuCount = provider.getGpuCount();
+      if (gpuCount > 0) {
+        gpuInfo.add("available", true);
+        gpuInfo.add("count", gpuCount);
+
+        long gpuMemoryTotal = provider.getGpuMemoryTotal();
+        long gpuMemoryUsed = provider.getGpuMemoryUsed();
+        long gpuMemoryFree = provider.getGpuMemoryFree();
+
+        if (gpuMemoryTotal > 0) {
+          SimpleOrderedMap<Object> memory = new SimpleOrderedMap<>();
+          memory.add("total", gpuMemoryTotal);
+          memory.add("used", gpuMemoryUsed);
+          memory.add("free", gpuMemoryFree);
+          gpuInfo.add("memory", memory);
+        }
+
+        var devices = provider.getGpuDevices();
+        if (devices != null && devices.size() > 0) {
+          gpuInfo.add("devices", devices);
+        }
+      } else {
+        gpuInfo.add("available", false);
+      }
+
+    } catch (Exception e) {
+      log.warn("Failed to get GPU information", e);
+      gpuInfo.add("available", false);
+    }
+
+    return gpuInfo;
+  }
+
   @Override
   public Name getPermissionName(AuthorizationContext request) {
     return Name.CONFIG_READ_PERM;

solr/core/src/java/org/apache/solr/metrics/GpuMetricsProvider.java

@@ -0,0 +1,32 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements.  See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF 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 org.apache.solr.metrics;
+
+import java.util.Map;
+
+public interface GpuMetricsProvider extends SolrMetricProducer {
+
+  long getGpuCount();
+
+  long getGpuMemoryTotal();
+
+  long getGpuMemoryUsed();
+
+  long getGpuMemoryFree();
+
+  Map<String, Object> getGpuDevices();
+}

solr/modules/cuvs/build.gradle

@@ -23,6 +23,8 @@ dependencies {
   implementation(libs.cuvs.lucene) {
     changing = true
   }
+  implementation libs.cuvs.java
+  implementation libs.opentelemetry.api
   implementation project(':solr:core')
   implementation project(':solr:solrj')
   implementation libs.apache.lucene.core