Sign up (with export icon)

Document observability hub

Show the table of contents

The Collaboration documents section lets you monitor the lifecycle of collaboration documents in an environment. It is a great place to start when investigating what happened to a document and when. For any document, you can check its current collaboration session and storage status, browse a chronological history of related events, review its save history, and download debug snapshot bundles for recovery or troubleshooting.

The feature is available in the Cloud Services Portal (or the Management Panel when using On-Premises). Open the Collaboration documents section for the selected environment.

Note

The Insights panel gathers environment-wide business logs, while the Document observability hub focuses on the per-document collaboration lifecycle (sessions, saves, and snapshots). The two views complement each other. See the Insights panel guide.

Collaboration documents list

Copy link

The landing view lists every document in the environment together with its current state, so you can check its status and spot problems at a glance.

The Collaboration documents list showing session and storage status for each document.

The Session and Storage columns show the current state of each document. A Not stored properly status (highlighted in red) flags a document whose most recent save failed, while Unknown means no save information is available yet.

Each row has two actions: Insights opens the Insights panel filtered to that document, and Details opens the per-document view with the Collaboration history, Snapshots, and Storage tabs described below.

You can filter the list by Document ID.

Collaboration history

Copy link

The Collaboration history tab is a chronological log of a document’s session and save events – when collaboration sessions started, ended, or expired, and when the document was saved or a save failed. It is the quickest way to check what happened to a document and when; for lower-level, more verbose detail on any entry, use the Insights panel.

The Collaboration history tab listing document actions with timestamps and trace IDs.

The recorded actions include, for example:

  • Session started – a collaboration session was opened.
  • Session ended – a collaboration session was closed.
  • Session expired – a session ended automatically (for example, after a timeout).
  • Document saved – the document was successfully persisted to storage.
  • Document save failed – a save attempt failed.

Actions performed automatically by the server are attributed to the system user. Each action also carries a Trace ID – click it to open the Insights panel filtered to that trace ID, where you can inspect the detailed logs for that action.

You can filter the history by User ID and Action, and narrow it to a time range with the From / To date pickers. Expand a row to see additional details.

Snapshots

Copy link

The Snapshots tab lists collaboration snapshot debug bundles. A debug bundle is self-contained – it includes the document snapshot, the editor bundle (if uploaded), and the editor configuration – so it captures everything needed to reproduce or recover the document at that point in time. Download a bundle to recover content or to share with support when investigating an issue.

The Snapshots tab listing downloadable debug bundles for a document.

The Source column shows what triggered the snapshot (for example, collaboration-document-session-ended). Use the Download action to retrieve a bundle and filter the list by Source.

Note

Snapshots are retained for a limited time; older snapshots are removed automatically.

Storage

Copy link

The Storage tab lists consecutive saves of a document in document storage. It is useful for inspecting current and historic storage size and the status of each save.

Note

The Storage tab is only meaningful when document storage is enabled for the environment. Without it, documents are not saved permanently, so there are no saves to list.

The Storage tab listing consecutive saves with size and status.

A Not stored properly status (highlighted in red) indicates a failed save – the document could not be persisted to storage. A common cause is a missing or incompatible editor bundle, which document storage relies on; see features that require the editor bundle for what to upload and why.

The Size change column shows how much the document size changed compared with the previous save, which is useful for spotting anomalies. A large, unexpected jump may indicate content bloat – for example, an accidental bulk paste or a misbehaving plugin – while a sharp drop can point to accidental content loss. To surface such outliers across a document’s history, filter the list by a minimum or maximum size change range.

You can also filter saves by Storage status.