Add documents and embbedings database metrics to stats response

[Alirexaa]

Pull Request

Related issue

Fixes #650
Fixes #649

What does this PR do?

This pull request includes an update to the IndexStats struct in the src/indexes.rs file to add several new fields for more detailed tracking of index statistics.

Changes in IndexStats struct:

• Added raw_document_db_size field to track the size of the raw document database.
• Added avg_document_size field to track the average size of documents.
• Added number_of_embedded_documents field to track the number of embedded documents.
• Added number_of_embeddings field to track the number of embeddings.

PR checklist

Please check if your PR fulfills the following requirements:

• Does this PR fix an existing issue, or have you listed the changes applied in the PR description (and why they are needed)?
• Have you read the contributing guidelines?
• Have you made sure that the title is accurate and descriptive of the changes?

Thank you so much for contributing to Meilisearch!

Summary by CodeRabbit

• New Features

  • Expanded index statistics with new details, including storage size, average document size, number of documents with embeddings, and total embeddings count.

• Documentation

  • Improved descriptions for all index statistics fields in the API.

[coderabbitai]

Important

Review skipped

Auto reviews are disabled on base/target branches other than the default branch.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Walkthrough

The IndexStats struct in src/indexes.rs has been updated to include four new fields for detailed index metrics: raw_document_db_size, avg_document_size, number_of_embedded_documents, and number_of_embeddings. Documentation comments have been added to all fields for clarity.

Changes

File(s)	Change Summary
src/indexes.rs	Added four new fields to IndexStats struct for document and embedding metrics; added doc comments to all fields.

Sequence Diagram(s)

sequenceDiagram
    participant API
    participant IndexStats

    API->>IndexStats: Request statistics
    IndexStats-->>API: Respond with number_of_documents, is_indexing, field_distribution, raw_document_db_size, avg_document_size, number_of_embedded_documents, number_of_embeddings

Loading

Assessment against linked issues

Objective	Addressed	Explanation
Add rawDocumentDbSize and avgDocumentSize to stats API responses (#650)	✅
Add numberOfEmbeddedDocuments and numberOfEmbeddings to stats API responses (#649)	✅

Poem

In fields of stats where numbers play,
New metrics join the fray today!
Documents and embeddings counted true,
With sizes and averages, all fresh and new.
The index now sings a richer song—
More data for the bunny to hop along! 🐇📊

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Explain this complex logic.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai explain this code block.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and explain its main purpose.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR.
• @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[Mubelotix]

Thank you for your contribution!