Document Server Metrics - ONLYOFFICE/Kubernetes-Docs GitHub Wiki

This article shows and describes the metrics collected from the Document Server that can be visualized using Grafana, for instance.

The metrics include the following sections with corresponding data

image

Connecting

  • Number of connections established in editing mode
  • Number of connections established in viewing mode
  • Total number of connections established (the total number of connections for viewing and editing) image

Opening

  • Average time it takes to open documents
  • Number of opened documents at the moment image

Downloading

  • Average download time of documents
  • Number of downloaded documents image

Converting Documents

  • Average conversion time of documents
  • Number of conversions
  • Quantile (0.5/0.9/0.99). This means that we exclude 1%, 10%, 50% of the highest values respectively, the rest are within either 1 or 3 seconds which is shown on the corresponding quantile graph.

image

Converting Process

  • Average conversion time. This is the average time it takes to perform any conversion task (x2t usage). Can be used to check if there are any delays with conversion.
  • Number of conversions. This is the number of such conversions performed. Can be used to have a general clue on how many conversions occur.
  • Quantile (0.5/0.9/0.99). This means that we exclude 1%, 10%, 50% of the highest values respectively, the rest are within either 1 or 3 seconds which is shown on the corresponding quantile graph. image

Authorizations

  • Average authorization time
  • Number of authorizations

By authorization here we mean the actions that are performed during the connection establishment. The most important here is the token checks (from the document management system / integrator) and launch of files conversion. Thus, these two metrics provide the average time it takes to perform these authorizations and their number. image

Get lock

  • Average time to obtain locking of items in documents when editing
  • Number of locked items in documents when editing

By Get Lock we mean an internal editor command which blocks documents contents, it is mainly used when 'strict' co-editing mode is selected in the editor interface. image

Saving Changes

  • Average time to save changes in documents
  • Number of document saves image

Uploading Images

  • Average time to open documents with images
  • Number of opening image documents image