v1.13: New /stats fields

[guimachiavelli]

v1.13 adds three new fields to the stats object:

• usedDatabaseSize corresponds to the total space used by the data stored in Meilisearch. This value doesn't count the unused space claimed by LMDB, removing documents from the DB will decrease this value.
• numberOfEmbeddings represents the total number of embeddings representation that exists in that indexes. A document can contains a representation per embedder used. so basically => numberOfEmbeddedDocuments * the number of embedder they have a rep for
• numberOfEmbeddedDocuments represents the number of document in an index that contains at least one embedded representation — this is the one we will likely sum at a project level when we bill AI documents in the futur
• rawDocumentDbSize corresponds to the total size of the documents stored in Meilisearch.
• maxDocumentSize corresponds to the size of the biggest document in the database.
• avgDocumentSize corresponds to the total size of the documents stored in Meilisearch divided by the number of documents.

usedDatabaseSize is differente from databaseSize. The latter corresponds to the total disk space claimed by Meilisearch. Because LMDB doesn't free the unused space, deleting documents will not decrease this value.

Tasks

• Update /reference/api/stats.mdx

References

• Slack discussion (private link): https://meilisearch.slack.com/archives/C01BDAZ8GFQ/p1738832244188729?thread_ts=1738788317.686599&cid=C01BDAZ8GFQ
• engine issues: Add embeddings database metrics to stats route meilisearch#5321, Add usedDatabaseSize to stats route meilisearch#5318, Add documents database metrics to stats route meilisearch#5319
• SME: @ManyTheFish

[guimachiavelli]

Due to performance reasons, the following won't be included in v1.13:

• rawDocumentDbSize
• maxDocumentSize
• avgDocumentSize