MINOR - React and Java telemetry (open-metadata#27773)

* chore: added sentry for UI

* chore: added sentry for UI

* chore: added sentry for UI

* chore: added sentry for UI and backend

* chore: move setup to config

* Update generated TypeScript types

* chore: addressed CI comments

* chore: handle no ui startup in IndexResource

---------

Co-authored-by: IceS2 <pablo.takara@getcollate.io>
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>

Author: 3 people

openmetadata-service/src/main/java/org/openmetadata/service/OpenMetadataApplication.java

@@ -137,6 +137,7 @@
 import org.openmetadata.service.resources.filters.ETagResponseFilter;
 import org.openmetadata.service.resources.settings.SettingsCache;
 import org.openmetadata.service.resources.system.DiagnosticsResource;
+import org.openmetadata.service.resources.system.IndexResource;
 import org.openmetadata.service.search.SearchIndexRetryWorker;
 import org.openmetadata.service.search.SearchRepository;
 import org.openmetadata.service.search.SearchRepositoryFactory;
@@ -364,6 +365,7 @@ public void run(OpenMetadataApplicationConfig catalogConfig, Environment environ
     EventPubSub.start();
 
     ApplicationHandler.initialize(catalogConfig);
+    IndexResource.initialize(catalogConfig);
     registerResources(catalogConfig, environment, jdbi);
 
     // Register Event Handler

openmetadata-service/src/main/java/org/openmetadata/service/OpenMetadataApplicationConfig.java

@@ -34,6 +34,7 @@
 import org.openmetadata.schema.configuration.AdminOpsConfiguration;
 import org.openmetadata.schema.configuration.AiPlatformConfiguration;
 import org.openmetadata.schema.configuration.LimitsConfiguration;
+import org.openmetadata.schema.configuration.SentryConfiguration;
 import org.openmetadata.schema.security.scim.ScimConfiguration;
 import org.openmetadata.schema.security.secrets.SecretsManagerConfiguration;
 import org.openmetadata.schema.service.configuration.elasticsearch.ElasticSearchConfiguration;
@@ -167,6 +168,16 @@ public AdminOpsConfiguration getAdminOpsConfiguration() {
     return adminOpsConfiguration;
   }
 
+  @JsonProperty("sentry")
+  private SentryConfiguration sentryConfiguration;
+
+  public SentryConfiguration getSentryConfiguration() {
+    if (sentryConfiguration == null) {
+      sentryConfiguration = new SentryConfiguration();
+    }
+    return sentryConfiguration;
+  }
+
   @JsonProperty("mcpConfiguration")
   private org.openmetadata.schema.api.configuration.MCPConfiguration mcpConfiguration;
 

openmetadata-service/src/main/java/org/openmetadata/service/resources/system/IndexResource.java

@@ -14,51 +14,65 @@
 import java.nio.charset.StandardCharsets;
 import java.util.stream.Collectors;
 import lombok.extern.slf4j.Slf4j;
+import org.apache.commons.text.StringEscapeUtils;
+import org.openmetadata.schema.configuration.SentryConfiguration;
 import org.openmetadata.service.OpenMetadataApplicationConfig;
+import org.openmetadata.service.resources.version.VersionResource;
 import org.openmetadata.service.security.CspNonceHandler;
 
 @Slf4j
 @Path("/")
 public class IndexResource {
-  private static final String RAW_INDEX_HTML;
+  private static volatile String configProcessedHtml;
+  private static volatile String configuredBasePath = "/";
 
-  static {
+  public static void initialize(OpenMetadataApplicationConfig catalogConfig) {
+    String rawIndexHtml;
     try (InputStream inputStream = IndexResource.class.getResourceAsStream("/assets/index.html")) {
       if (inputStream == null) {
-        throw new IllegalStateException("Missing required resource: /assets/index.html");
+        LOG.warn("UI assets not found on classpath. Running in no-ui mode.");
+        return;
       }
-      RAW_INDEX_HTML =
+      rawIndexHtml =
           new BufferedReader(new InputStreamReader(inputStream, StandardCharsets.UTF_8))
               .lines()
               .collect(Collectors.joining("\n"));
     } catch (IOException e) {
       throw new IllegalStateException("Failed to load /assets/index.html", e);
     }
-  }
-
-  private String indexHtml;
 
-  public IndexResource() {
-    indexHtml = RAW_INDEX_HTML;
+    String basePath = catalogConfig.getBasePath();
+    configuredBasePath = (basePath != null && !basePath.isEmpty()) ? basePath : "/";
+    SentryConfiguration sentryConfig = catalogConfig.getSentryConfiguration();
+    String clusterName = catalogConfig.getClusterName();
+    configProcessedHtml =
+        rawIndexHtml
+            .replace("${sentryEnabled}", String.valueOf(sentryConfig.getEnabled()))
+            .replace("${sentryDsn}", escapeJs(sentryConfig.getUiDsn()))
+            .replace("${sentryEnvironment}", escapeJs(sentryConfig.getEnvironment()))
+            .replace(
+                "${sentryTraceSampleRate}",
+                escapeJs(String.valueOf(sentryConfig.getTracesSampleRate())))
+            .replace("${clusterName}", escapeJs(clusterName != null ? clusterName : "openmetadata"))
+            .replace(
+                "${appVersion}", escapeJs(new VersionResource().getCatalogVersion().getVersion()));
   }
 
-  public void initialize(OpenMetadataApplicationConfig config) {
-    this.indexHtml = this.indexHtml.replace("${basePath}", config.getBasePath());
+  private static String escapeJs(String value) {
+    if (value == null) {
+      return "";
+    }
+    return StringEscapeUtils.escapeEcmaScript(value);
   }
 
   public static String getIndexFile(String basePath) {
-    LOG.debug("IndexResource.getIndexFile called with basePath: [{}]", basePath);
-
-    String result = RAW_INDEX_HTML.replace("${basePath}", basePath);
-    String basePathLine =
-        result
-            .lines()
-            .filter(line -> line.contains("window.BASE_PATH"))
-            .findFirst()
-            .orElse("NOT FOUND");
-    LOG.debug("After replacement, window.BASE_PATH line: {}", basePathLine.trim());
+    String html = configProcessedHtml;
+    if (html == null) {
+      throw new IllegalStateException("IndexResource not initialized. Call initialize() first.");
+    }
 
-    return result;
+    LOG.debug("IndexResource.getIndexFile called with basePath: [{}]", basePath);
+    return html.replace("${basePath}", basePath);
   }
 
   public static String getIndexFile(String basePath, String cspNonce) {
@@ -73,10 +87,6 @@ public static String getIndexFile(String basePath, String cspNonce) {
   @Produces(MediaType.TEXT_HTML)
   public Response getIndex(@Context HttpServletRequest request) {
     final String cspNonce = (String) request.getAttribute(CspNonceHandler.CSP_NONCE_ATTRIBUTE);
-    String html = indexHtml;
-    if (cspNonce != null && !cspNonce.isEmpty()) {
-      html = html.replace("${cspNonce}", cspNonce);
-    }
-    return Response.ok(html).build();
+    return Response.ok(getIndexFile(configuredBasePath, cspNonce)).build();
   }
 }

openmetadata-service/src/test/java/org/openmetadata/service/resources/system/IndexResourceTest.java

@@ -25,20 +25,28 @@
 import java.util.Base64;
 import java.util.regex.Matcher;
 import java.util.regex.Pattern;
+import org.junit.jupiter.api.BeforeAll;
 import org.junit.jupiter.api.BeforeEach;
 import org.junit.jupiter.api.Test;
+import org.openmetadata.schema.configuration.SentryConfiguration;
 import org.openmetadata.service.OpenMetadataApplicationConfig;
 import org.openmetadata.service.security.CspNonceHandler;
 
 class IndexResourceTest {
   private IndexResource resource;
-  private OpenMetadataApplicationConfig config;
+
+  @BeforeAll
+  static void initIndex() {
+    OpenMetadataApplicationConfig config = mock(OpenMetadataApplicationConfig.class);
+    SentryConfiguration sentryConfig = new SentryConfiguration();
+    when(config.getSentryConfiguration()).thenReturn(sentryConfig);
+    when(config.getClusterName()).thenReturn("test-cluster");
+    IndexResource.initialize(config);
+  }
 
   @BeforeEach
   void setUp() {
     resource = new IndexResource();
-    config = mock(OpenMetadataApplicationConfig.class);
-    when(config.getBasePath()).thenReturn("/");
   }
 
   @Test
@@ -76,8 +84,6 @@ void testStaticGetIndexFileWithNonce() {
 
   @Test
   void testGetIndexWithRequest() {
-    resource.initialize(config);
-
     HttpServletRequest mockRequest = mock(HttpServletRequest.class);
     String testNonce = Base64.getEncoder().encodeToString("test-nonce-bytes".getBytes());
     when(mockRequest.getAttribute(CspNonceHandler.CSP_NONCE_ATTRIBUTE)).thenReturn(testNonce);
@@ -97,8 +103,6 @@ void testGetIndexWithRequest() {
 
   @Test
   void testGetIndexWithNullNonce() {
-    resource.initialize(config);
-
     HttpServletRequest mockRequest = mock(HttpServletRequest.class);
     when(mockRequest.getAttribute(CspNonceHandler.CSP_NONCE_ATTRIBUTE)).thenReturn(null);
 
@@ -111,8 +115,6 @@ void testGetIndexWithNullNonce() {
 
   @Test
   void testGetIndexWithEmptyNonce() {
-    resource.initialize(config);
-
     HttpServletRequest mockRequest = mock(HttpServletRequest.class);
     when(mockRequest.getAttribute(CspNonceHandler.CSP_NONCE_ATTRIBUTE)).thenReturn("");
 

openmetadata-spec/src/main/resources/json/schema/configuration/sentryConfiguration.json

@@ -0,0 +1,48 @@
+{
+  "$id": "https://open-metadata.org/schema/configuration/sentryConfiguration.json",
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "title": "SentryConfiguration",
+  "description": "This schema defines the Sentry Configuration for error tracking and performance monitoring.",
+  "type": "object",
+  "javaType": "org.openmetadata.schema.configuration.SentryConfiguration",
+  "properties": {
+    "enabled": {
+      "description": "Indicates whether Sentry error tracking is enabled.",
+      "type": "boolean",
+      "default": false
+    },
+    "backendDsn": {
+      "description": "Sentry Data Source Name (DSN) for the backend.",
+      "type": "string",
+      "default": ""
+    },
+    "uiDsn": {
+      "description": "Sentry Data Source Name (DSN) for the UI.",
+      "type": "string",
+      "default": ""
+    },
+    "environment": {
+      "description": "Environment label sent to Sentry (e.g., development, staging, production).",
+      "type": "string",
+      "default": "development"
+    },
+    "serverName": {
+      "description": "Server name reported to Sentry.",
+      "type": "string",
+      "default": "openmetadata"
+    },
+    "tracesSampleRate": {
+      "description": "Sample rate for performance traces (0.0 to 1.0).",
+      "type": "number",
+      "default": 0.5,
+      "minimum": 0.0,
+      "maximum": 1.0
+    },
+    "debug": {
+      "description": "Enable Sentry SDK debug mode.",
+      "type": "boolean",
+      "default": false
+    }
+  },
+  "additionalProperties": false
+}

openmetadata-ui/src/main/resources/ui/src/generated/configuration/sentryConfiguration.ts

@@ -0,0 +1,46 @@
+/*
+ *  Copyright 2026 Collate.
+ *  Licensed 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.
+ */
+/**
+ * This schema defines the Sentry Configuration for error tracking and performance
+ * monitoring.
+ */
+export interface SentryConfiguration {
+    /**
+     * Sentry Data Source Name (DSN) for the backend.
+     */
+    backendDsn?: string;
+    /**
+     * Enable Sentry SDK debug mode.
+     */
+    debug?: boolean;
+    /**
+     * Indicates whether Sentry error tracking is enabled.
+     */
+    enabled?: boolean;
+    /**
+     * Environment label sent to Sentry (e.g., development, staging, production).
+     */
+    environment?: string;
+    /**
+     * Server name reported to Sentry.
+     */
+    serverName?: string;
+    /**
+     * Sample rate for performance traces (0.0 to 1.0).
+     */
+    tracesSampleRate?: number;
+    /**
+     * Sentry Data Source Name (DSN) for the UI.
+     */
+    uiDsn?: string;
+}