Metrics | DOCX Editor

Every metric that the telemetry package records, with its Prometheus name, type, and labels.

@docx-editor.dev/telemetry is available in version 2.29.0 and later.

Each metric has an OpenTelemetry name and a derived Prometheus name. For example, docx_editor.collab.room.load.duration becomes docx_editor_collab_room_load_duration_seconds. Built-in labels use predefined values to limit the number of series. Optional per-room metrics use room identifiers.

Every editor metric includes docx_editor.version, which becomes docx_editor_version in Prometheus. This label identifies the editor package version, so you can compare releases. Server metrics omit this label. Editor metrics also include keys from metricLabels, such as app.version.

Prometheus name	Type	Labels	Description
`docx_editor_document_opens_total`	counter	`outcome`, `code`, `cause`, `part`, `docx_editor.version`	Documents opened or refused, by outcome, refusal code, engine reason, and part role.
`docx_editor_document_open_duration_seconds`	histogram	`docx_editor.version`	Time from the start of an open to the laid-out document.
`docx_editor_edit_rejections_total`	counter	`code`, `cause`, `origin`, `tracked`, `docx_editor.version`	Edits, commands, and tracked changes refused, by public code and engine reason.
`docx_editor_review_skipped_total`	counter	`code`, `cause`, `operation`, `change_kind`, `docx_editor.version`	Tracked changes skipped by accept, reject, or reassign requests, by engine reason, operation, and change kind.
`docx_editor_font_failures_total`	counter	`code`, `docx_editor.version`	Font faces that failed to load and were substituted.
`docx_editor_history_diagnostics_total`	counter	`code`, `docx_editor.version`	Undo steps that did not group as the gesture intended, by code.
`docx_editor_custom_node_diagnostics_total`	counter	`code`, `docx_editor.version`	Custom node payloads that could not be read, by code.
`docx_editor_collab_client_status_transitions_total`	counter	`status`, `code`, `docx_editor.version`	Collaboration status changes on clients, by new status and failure code.
`docx_editor_collab_client_connect_duration_seconds`	histogram	`docx_editor.version`	Time from an editor attaching a room to its first ready status, when the editor attached before the room was ready.
`docx_editor_collab_client_participants`	histogram	`docx_editor.version`	People in the room, as each client sees it when the count changes.
`docx_editor_editor_interaction_duration_seconds`	histogram	`pages`, `docx_editor.version`	Key presses and pointer presses on the pages, to the next frame on screen, by page count bucket. Bucket counts are exact; the sum is estimated from the bands.
`docx_editor_editor_layout_duration_seconds`	histogram	`pages`, `docx_editor.version`	Engine layout passes after edits and view changes, background work included, by page count bucket. Bucket counts are exact; the sum is estimated from the bands.
`docx_editor_editor_paint_duration_seconds`	histogram	`pages`, `docx_editor.version`	Engine paints of the pages, by page count bucket. Bucket counts are exact; the sum is estimated from the bands.
`docx_editor_telemetry_dropped_events_total`	counter	`reason`, `docx_editor.version`	Events the anonymity guard dropped, by reason. Usually a version mismatch.
`docx_editor_collab_rooms_active`	gauge	none	Rooms loaded.
`docx_editor_collab_connections_active`	gauge	none	Open client connections. One person with two tabs is two connections.
`docx_editor_collab_participants_active`	gauge	none	People present in all rooms, from awareness states.
`docx_editor_collab_room_participants`	histogram	none	People present in each room, sampled once per room per interval.
`docx_editor_collab_room_participants_max`	gauge	none	People in the fullest room now.
`docx_editor_collab_room_memory_bytes`	histogram	`kind`	Bytes each room holds, sampled per room: encoded state, blobs, and updates not yet stored.
`docx_editor_collab_rooms_memory_bytes`	gauge	`kind`	Bytes all rooms hold together at the last sample.
`docx_editor_collab_room_nodes`	histogram	`state`	Shared document nodes per room, live and tombstoned.
`docx_editor_collab_room_resource_usage`	histogram	`resource`	Share of each room resource limit in use, from 0 to 1.
`docx_editor_collab_room_age_seconds`	histogram	none	How long each room has been loaded.
`docx_editor_collab_room_idle_seconds`	histogram	none	Time since each room last changed.
`docx_editor_collab_room_load_duration_seconds`	histogram	`outcome`	Time to load a room, by outcome.
`docx_editor_collab_room_store_duration_seconds`	histogram	`outcome`	Time to store a room, by outcome.
`docx_editor_collab_admission_rejections_total`	counter	`reason`	Connections refused at admission, by reason.
`docx_editor_collab_message_refusals_total`	counter	`reason`	Messages refused before they applied, by reason, such as room-generation-changed.
`docx_editor_collab_updates_total`	counter	none	Document updates applied to rooms.
`docx_editor_collab_update_bytes_total`	counter	none	Bytes of document updates applied to rooms.
`docx_editor_collab_room_participants_current`	gauge	`room`	People in each room, labeled by room. Recorded only with `perRoomSeries`.
`docx_editor_collab_room_memory_current_bytes`	gauge	`room`, `kind`	Bytes each room holds, labeled by room and kind. Recorded only with `perRoomSeries`.
`docx_editor_collab_migrations_total`	counter	`outcome`	Room migrations, by outcome.