Skip to content

The Open Standard for Generative UI

Make lang-core runtime telemetry opt-in (#991)

devin-ai-integration[bot]a59581ef0f8d
diff --git a/packages/lang-core/README.md b/packages/lang-core/README.md
index cf27acd88..fec6ee45f 100644
--- a/packages/lang-core/README.md
+++ b/packages/lang-core/README.md
@@ -107,14 +107,15 @@ const merged = mergeStatements(original, patch);
## Telemetry
-Lang Core sends pseudonymous installation telemetry during `postinstall` and
-collects limited usage telemetry from 10% of successful server-side
-`generateSystemPrompt()` calls. It does not collect application-user data,
-prompts, messages, generated output, credentials, or raw component and tool
-definitions. Project identifiers are hashed locally before being sent, and
-browsers do not send telemetry.
-
-Set `OPENUI_TELEMETRY_DISABLED=1` or `DO_NOT_TRACK=1` to disable telemetry. Set
+Lang Core sends pseudonymous installation telemetry during `postinstall`.
+Runtime usage telemetry is opt-in: set `OPENUI_RUNTIME_TELEMETRY_ENABLED=1` to allow
+limited telemetry from 10% of successful server-side `generateSystemPrompt()`
+calls. It does not collect application-user data, prompts, messages, generated
+output, credentials, or raw component and tool definitions. Project identifiers
+are hashed locally before being sent, and browsers do not send telemetry.
+
+Set `OPENUI_TELEMETRY_DISABLED=1` or `DO_NOT_TRACK=1` to disable telemetry
+(these also override `OPENUI_RUNTIME_TELEMETRY_ENABLED`). Set
`OPENUI_TELEMETRY_DEBUG=1` to print the installation payload to stdout without
sending it.
diff --git a/packages/lang-core/src/telemetry/runtime.ts b/packages/lang-core/src/telemetry/runtime.ts
index 0359b291a..4b914e3d3 100644
--- a/packages/lang-core/src/telemetry/runtime.ts
+++ b/packages/lang-core/src/telemetry/runtime.ts
@@ -1,7 +1,7 @@
import type { PromptSpec } from "../parser/prompt";
import {
getPostHogConfig,
- isTelemetryDisabled,
+ isRuntimeTelemetryEnabled,
normalizeProjectIdentity,
TELEMETRY_REQUEST_TIMEOUT_MS,
TELEMETRY_SCHEMA_VERSION,
@@ -10,6 +10,8 @@ import {
/**
* Telemetry disclosure
*
+ * Opt-in: nothing is sent unless OPENUI_RUNTIME_TELEMETRY_ENABLED=1 is set.
+ *
* Sent for sampled server-side generations:
* - Event timestamp, SDK and runtime versions, environment, CI status, and CI provider category
* - API input shape, component count, tool count, and schema/sample versions
@@ -374,7 +376,7 @@ export function recordSystemPromptGeneration(spec: PromptSpec, inputShape: Input
const env = runtime.env;
const environment = getEnvironment(env);
- if (isTelemetryDisabled(env)) return;
+ if (!isRuntimeTelemetryEnabled(env)) return;
// Reject 90% of calls before projection, hashing, repository lookup, or payload allocation.
if (Math.random() >= SAMPLE_RATE) return;
diff --git a/packages/lang-core/src/telemetry/shared.ts b/packages/lang-core/src/telemetry/shared.ts
index fefc605e9..6fc7350cb 100644
--- a/packages/lang-core/src/telemetry/shared.ts
+++ b/packages/lang-core/src/telemetry/shared.ts
@@ -25,6 +25,11 @@ export function isTelemetryDisabled(env?: TelemetryEnvironment): boolean {
return isTruthyEnv(env?.["OPENUI_TELEMETRY_DISABLED"]) || isTruthyEnv(env?.["DO_NOT_TRACK"]);
}
+/** Runtime telemetry is opt-in: it requires explicit consent and honors the disable flags. */
+export function isRuntimeTelemetryEnabled(env?: TelemetryEnvironment): boolean {
+ return isTruthyEnv(env?.["OPENUI_RUNTIME_TELEMETRY_ENABLED"]) && !isTelemetryDisabled(env);
+}
+
export function normalizeProjectIdentity(rawValue: string): string {
const value = rawValue.trim();
if (!value) return "";