Analytics configuration is the responsibility of the host application when running in widget mode (#3089)

* Support for analytics configuration via URL parameters in widget mode

Adds:

- posthogApiHost
- posthogApiKey
- rageshakeSubmitUrl
- sentryDsn
- sentryEnvironment

Deprecate analyticsId and use posthogUserId instead

* Partial test coverage

* Simplify tests

* More tests

* Lint

* Split embedded only parameters into own section for clarity

* Update docs/url-params.md

* Update docs/url-params.md

* Update vite.config.js

src/otel/otel.test.ts

@@ -0,0 +1,79 @@
+/*
+Copyright 2025 New Vector Ltd.
+
+SPDX-License-Identifier: AGPL-3.0-only OR LicenseRef-Element-Commercial
+Please see LICENSE in the repository root for full details.
+*/
+
+import {
+  expect,
+  describe,
+  it,
+  vi,
+  beforeEach,
+  beforeAll,
+  afterAll,
+} from "vitest";
+
+import { ElementCallOpenTelemetry } from "./otel";
+import { mockConfig } from "../utils/test";
+
+describe("ElementCallOpenTelemetry", () => {
+  describe("embedded package", () => {
+    beforeAll(() => {
+      vi.stubEnv("VITE_PACKAGE", "embedded");
+    });
+
+    beforeEach(() => {
+      mockConfig({});
+    });
+
+    afterAll(() => {
+      vi.unstubAllEnvs();
+    });
+
+    it("does not create instance without config value", () => {
+      ElementCallOpenTelemetry.globalInit();
+      expect(ElementCallOpenTelemetry.instance?.isOtlpEnabled).toBe(false);
+    });
+
+    it("ignores config value and does not create instance", () => {
+      mockConfig({
+        opentelemetry: {
+          collector_url: "https://collector.example.com.localhost",
+        },
+      });
+      ElementCallOpenTelemetry.globalInit();
+      expect(ElementCallOpenTelemetry.instance?.isOtlpEnabled).toBe(false);
+    });
+  });
+
+  describe("full package", () => {
+    beforeAll(() => {
+      vi.stubEnv("VITE_PACKAGE", "full");
+    });
+
+    beforeEach(() => {
+      mockConfig({});
+    });
+
+    afterAll(() => {
+      vi.unstubAllEnvs();
+    });
+
+    it("does not create instance without config value", () => {
+      ElementCallOpenTelemetry.globalInit();
+      expect(ElementCallOpenTelemetry.instance?.isOtlpEnabled).toBe(false);
+    });
+
+    it("creates instance with config value", () => {
+      mockConfig({
+        opentelemetry: {
+          collector_url: "https://collector.example.com.localhost",
+        },
+      });
+      ElementCallOpenTelemetry.globalInit();
+      expect(ElementCallOpenTelemetry.instance?.isOtlpEnabled).toBe(true);
+    });
+  });
+});

src/otel/otel.ts

@@ -16,6 +16,7 @@ import { logger } from "matrix-js-sdk/src/logger";
 import { PosthogSpanProcessor } from "../analytics/PosthogSpanProcessor";
 import { Config } from "../config/Config";
 import { RageshakeSpanProcessor } from "../analytics/RageshakeSpanProcessor";
+import { getRageshakeSubmitUrl } from "../settings/submit-rageshake";
 
 const SERVICE_NAME = "element-call";
 
@@ -28,20 +29,24 @@ export class ElementCallOpenTelemetry {
   public readonly rageshakeProcessor?: RageshakeSpanProcessor;
 
   public static globalInit(): void {
-    const config = Config.get();
+    // this is only supported in the full package as the is currently no support for passing in the collector URL from the widget host
+    const collectorUrl =
+      import.meta.env.VITE_PACKAGE === "full"
+        ? Config.get().opentelemetry?.collector_url
+        : undefined;
     // we always enable opentelemetry in general. We only enable the OTLP
     // collector if a URL is defined (and in future if another setting is defined)
     // Posthog reporting is enabled or disabled
     // within the posthog code.
-    const shouldEnableOtlp = Boolean(config.opentelemetry?.collector_url);
+    const shouldEnableOtlp = Boolean(collectorUrl);
 
     if (!sharedInstance || sharedInstance.isOtlpEnabled !== shouldEnableOtlp) {
       logger.info("(Re)starting OpenTelemetry debug reporting");
       sharedInstance?.dispose();
 
       sharedInstance = new ElementCallOpenTelemetry(
-        config.opentelemetry?.collector_url,
-        config.rageshake?.submit_url,
+        collectorUrl,
+        getRageshakeSubmitUrl(),
       );
     }
   }