Statistics: Stats View

• Studio's Stats view shows the statistics of a single database: the counts of the database's documents and document extensions, per-node details like the database ID and the size on disk, and the indexing counters of each index.

• The statistics are read when you open the view.
  To update the readings, you need to click Refresh.

• Statistics can also be retrieved using other Studio views and dedicated endpoints, listed in the Overview article.

• In this article:

  • The Stats view
  • Detailed Database Stats
  • Indexes Stats
    • The index tables
    • Staleness and errors
    • Indexes that load related documents

The Stats view

Any user with read access to the database can open this view.
Stats menu > Stats view

1. Stats
   Open the Stats menu.

2. Stats
   Open the Stats view.

3. Show detailed database & indexing stats
   Click to toggle on or off a detailed display of database and index statistics.

4. Refresh
   Read the statistics again and update the display.

5. Show raw output
   Open the JSON response of the /databases/<database name>/stats/essential endpoint in a new browser tab.

6. General Database Stats

   Count	Description
   Documents Count	The number of documents in the database.
   Counters Count	The number of counter entries.
   Attachments Count	The number of attachments in the database.
   Indexes Count	The number of indexes defined in the database.
   Revisions Count	The number of revisions stored.
   Conflicts Count	The number of documents that are currently in conflict.
   Tombstones Count	The number of tombstones, the markers left behind by deleted documents.
   Time Series Segments Count	The number of segments that hold the database's time series entries. A segment holds consecutive entries of one time series and grows to 2 KB at most, so a new segment is added as entries accumulate, or once enough time has passed since the last entry.

Detailed Database Stats

The Detailed Database Stats table holds one column per cluster node in the database group, and one column per shard on a sharded database.

1. Node columns
   The node the column's values were read from.
   On a sharded database the shard number is shown as well.

2. Copy to clipboard
   Copy the node's full change vector.
   The badges next to the button show each change vector entry in a shortened form; hovering over a badge shows the full entries.

3. Size On Disk
   Hovering over the value displays the sizes of the database's data files and temporary buffers.

   

4. Attachments
   The overall number of attachments.
   When the same file is attached to several documents, RavenDB stores the file once and all these attachments point to the single stored copy, so fewer files are stored than the overall number of attachments.
   The row then adds two figures: the number of files stored locally, and the number of attachments kept in remote storage.

The rows are:

Row	Description
Database ID	The unique identifier of the database instance on this node. Each node generates an identifier of its own.
Database Change Vector	The database's current change vector, with one entry per node that has written to the database.
Size On Disk	The disk space the database occupies on this node, including its temporary buffers.
Last Document ETag	The ETag of the most recent document change on this node.
Last Database ETag	The most recent ETag on this node across the whole database, including changes to documents, tombstones, revisions, conflicts, and attachments.
Architecture	The architecture of the server process on this node, 64-bit or 32-bit.
Documents	The number of documents on this node.
Counters	The number of counter entries on this node.
Identities	The number of identities the database has generated.
Indexes	The number of indexes defined in the database.
Revisions	The number of revisions on this node.
Conflicts	The number of documents that are currently in conflict on this node.
Attachments	The number of attachments on this node.
Compare Exchange	The number of compare exchange items. Compare exchange items are stored cluster-wide, so the value is identical for all nodes.
Tombstones	The number of tombstones on this node.
Time Series Segments	The number of time series segments on this node.

Indexes Stats

This section shows the indexing counters of each index, node by node.
The indexes are grouped by type, map indexes first and map-reduce indexes later, and each index name links to the Indexing Performance view for that index.

The index tables

A row appears only when the index has something to report for it, so two indexes in the same group can show different rows.

The rows are:

Row	Description
Staleness	A green check when the index has processed every document it needs to, or a Stale badge when some documents are not processed yet.
Node Tag	The node the column's values were read from.
Shard #	If the database is sharded: the shard the column's values were read from.
Entries Count	The number of entries the index currently holds. A single document can produce more than one entry.
Errors Count	The number of indexing errors stored for the index.
Map Attempts	The number of documents the index tried to map.
Map Successes	The number of documents the index mapped successfully.
Map Errors	The number of documents whose mapping failed.
Map Reference Attempts	The number of documents the index re-mapped because a document they reference had changed. Shown for indexes that load related documents.
Map Reference Successes	The number of the re-mappings that succeeded. Shown for indexes that load related documents.
Map Reference Errors	The number of the re-mappings that failed.
Mapped Per Second Rate	The rate at which the index is currently mapping documents. Shown while the rate exceeds one document per second.
Reduce Attempts	The number of reduce operations the index attempted. Shown for map-reduce indexes.
Reduce Successes	The number of reduce operations that succeeded. Shown for map-reduce indexes.
Reduce Errors	The number of reduce operations that failed.
Reduced Per Second Rate	The rate at which the index is currently reducing. Shown while the rate exceeds one operation per second.

Staleness and errors

1. Staleness
   A Stale badge means the index still has documents to process.
   Click the badge to open the list of reasons the index is stale.

2. Errors Count
   The number of errors stored for the index.
   RavenDB keeps the 500 most recent errors of each index, so the count stops at 500.

3. Map Errors
   The number of documents whose mapping failed.
   This counter is not capped, so an index that has failed on more than 500 documents shows a higher Map Errors than Errors Count.

To read the errors themselves, see Debugging index errors.

Indexes that load related documents

1. Map Reference Attempts and Map Reference Successes
   An index can use LoadDocument to read data from documents related to the document being indexed.
   When a related document changes, the index re-maps every document that references the changed document.
   Map Reference Attempts counts the documents re-mapped this way, and Map Reference Successes counts the documents whose re-mapping completed.

2. Referenced collections
   The collections the index loads related documents from.

Learn how to define an index that loads related documents in Indexing related documents.