Privacy review checklist
Check identifiers, consent, and SDK settings before you export editor telemetry.
@docx-editor.dev/telemetry is available in version 2.29.0 and later.Built-in events hold only codes, booleans, buckets, and timings, as Privacy describes. Use this checklist for what you control.
Check your configuration
| Check | Why | Guide |
|---|---|---|
| Exporters send only to approved backends. | Exporters decide where data goes. | Telemetry |
attributes and resource hold only pseudonymous IDs, never names, emails, titles, or file names. | Added identifiers can reveal users or documents. Event attributes accept strings up to 256 characters. | Identify rooms and users |
metricLabels lists only keys with few values. | A user or room ID label creates one series per user or room. | Identify rooms and users |
documentShape stays 'basic', or 'detailed' is approved. | Detailed bucket combinations can distinguish documents. | Privacy |
With a user ID on events, session timing is approved, or the sessions area is off. | Session timing plus user IDs exposes individual activity. | Sessions |
consent reads your consent manager, and your Sentry and OpenTelemetry SDKs follow the same decision. | consent controls only this package. | Set up an editor |
Sentry Replay blocks the editor, dropEditorBreadcrumbs is set, and dataCollection turns off user, cookie, header, body, and query collection. | Replay and breadcrumbs can capture document content. | Send to Sentry |
| Sentry URLs, request bodies, console breadcrumbs, and uncaught errors are scrubbed. | The package does not control SDK-collected values. | Send to Sentry |
| OpenTelemetry resource attributes and instrumentations hold no identifiers. | Some instrumentations add the user agent or page URL. | Send to OpenTelemetry |
rooms.list() sits behind an administrator endpoint, and roomLabel is the default or hmacRoomLabel. | Room listings can expose real room names. | Rooms, people, and memory |
Test exported events
Collect events with memoryExporter, then open, edit, and review a file that contains recognizable text:
import { createTelemetry, memoryExporter } from '@docx-editor.dev/telemetry';
export const memory = memoryExporter();
export const telemetry = createTelemetry({ exporters: [memory] });
/** Throws if any recorded event contains `text`. Call it after your test edits the file. */
export function assertNoDocumentText(text: string): void {
if (JSON.stringify(memory.events).includes(text))
throw new Error('A telemetry event contains document text.');
}During development, consoleExporter() prints each event as it would be sent.
Limits
- A text-sentinel test covers only the events and text it examines.
- The test does not see what your Sentry or OpenTelemetry SDK collects.
- Package validation does not prove that a pseudonymous identifier is not an email address.