Add documents and embbedings database metrics to stats response #652
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Co-authored-by: Frank Elsinga <[email protected]>
WalkthroughThe Changes
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
Assessment against linked issues
Poem
📜 Recent review detailsConfiguration used: CodeRabbit UI 📒 Files selected for processing (1)
⏰ Context from checks skipped due to timeout of 90000ms (4)
✨ Finishing Touches
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. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed 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)
Other keywords and placeholders
CodeRabbit Configuration File (
|
| @@ -1795,9 +1795,20 @@ impl<'a, Http: HttpClient> AsRef<IndexUpdater<'a, Http>> for IndexUpdater<'a, Ht | |||
| #[derive(Debug, Clone, Deserialize)] | |||
There was a problem hiding this comment.
thinking about it, this should also be non_exhaustive.
There are bound to be more stats in the future
Suggested change
| #[derive(Debug, Clone, Deserialize)] | |
| #[non_exhaustive] | |
| #[derive(Debug, Clone, Deserialize)] |
| @@ -1795,9 +1795,20 @@ impl<'a, Http: HttpClient> AsRef<IndexUpdater<'a, Http>> for IndexUpdater<'a, Ht | |||
| #[derive(Debug, Clone, Deserialize)] | |||
| #[serde(rename_all = "camelCase")] | |||
| pub struct IndexStats { | |||
There was a problem hiding this comment.
Lets also add more doc-comments here
Suggested change
| pub struct IndexStats { | |
| /// Gives extended information and metrics about indexes and the Meilisearch database | |
| pub struct IndexStats { |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Pull Request
Related issue
Fixes #650
Fixes #649
What does this PR do?
This pull request includes an update to the
IndexStatsstruct in thesrc/indexes.rsfile to add several new fields for more detailed tracking of index statistics.Changes in
IndexStatsstruct:raw_document_db_sizefield to track the size of the raw document database.avg_document_sizefield to track the average size of documents.number_of_embedded_documentsfield to track the number of embedded documents.number_of_embeddingsfield to track the number of embeddings.PR checklist
Please check if your PR fulfills the following requirements:
Thank you so much for contributing to Meilisearch!
Summary by CodeRabbit
New Features
Documentation