Add analytics on the get / fetch document route #3737
Assignees
Labels
enhancement
New feature or improvement
impacts docs
This issue involves changes in the Meilisearch's documentation
v1.2.0
PRs/issues solved in v1.2.0 released on 2023-06-05
Milestone
Comments
curquiza
added
impacts docs
meili-bors bot
added a commit
that referenced
this issue
May 16, 2023
3738: Add analytics on the get documents resource r=irevoire a=irevoire # Pull Request ## Related issue Fixes #3737 Related spec meilisearch/specifications#234 ## What does this PR do? Add the analytics for the following routes: - `GET` - `/indexes/:uid/documents` - `GET` - `/indexes/:uid/documents/:doc_id` - `POST` - `/indexes/:uid/documents/fetch` These analytics are aggregated between two events: - `Documents Fetched GET` - `Documents Fetched POST` That shares the same payload: Property name | Description | Example | |---------------|-------------|---------| | `requests.total_received` | Total number of request received in this batch | 325 | | `per_document_id` | `false` | false | | `per_filter` | `true` if `POST /indexes/:indexUid/documents/fetch` endpoint was used with a filter in this batch, otherwise `false` | false | | `pagination.max_limit` | Highest value given for the `limit` parameter in this batch | 60 | | `pagination.max_offset` | Highest value given for the `offset` parameter in this batch | 1000 | Co-authored-by: Tamo <tamo@meilisearch.com>
meili-bors bot
added a commit
that referenced
this issue
May 16, 2023
3738: Add analytics on the get documents resource r=dureuill a=irevoire # Pull Request ## Related issue Fixes #3737 Related spec meilisearch/specifications#234 ## What does this PR do? Add the analytics for the following routes: - `GET` - `/indexes/:uid/documents` - `GET` - `/indexes/:uid/documents/:doc_id` - `POST` - `/indexes/:uid/documents/fetch` These analytics are aggregated between two events: - `Documents Fetched GET` - `Documents Fetched POST` That shares the same payload: Property name | Description | Example | |---------------|-------------|---------| | `requests.total_received` | Total number of request received in this batch | 325 | | `per_document_id` | `false` | false | | `per_filter` | `true` if `POST /indexes/:indexUid/documents/fetch` endpoint was used with a filter in this batch, otherwise `false` | false | | `pagination.max_limit` | Highest value given for the `limit` parameter in this batch | 60 | | `pagination.max_offset` | Highest value given for the `offset` parameter in this batch | 1000 | Co-authored-by: Tamo <tamo@meilisearch.com>
|
Fixed by #3738 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Related spec: meilisearch/specifications#234
Motivation
We didn't have the time to implement the analytics before the end of the sprint on the get documents route.
Add the analytics for the following routes:
GET-/indexes/:uid/documentsGET-/indexes/:uid/documents/:doc_idPOST-/indexes/:uid/documents/fetchThese analytics are aggregated between two events:
Documents Fetched GETDocuments Fetched POSTThat shares the same payload:
requests.total_receivedper_document_idfalseper_filtertrueifPOST /indexes/:indexUid/documents/fetchendpoint was used with a filter in this batch, otherwisefalsepagination.max_limitlimitparameter in this batchpagination.max_offsetoffsetparameter in this batchTODO
Impacted teams
@meilisearch/docs-team
The text was updated successfully, but these errors were encountered: