Skip to content
This repository has been archived by the owner on Mar 21, 2024. It is now read-only.

Document the latest metrics improvements #242

Merged
merged 9 commits into from
Jul 31, 2023

Conversation

irevoire
Copy link
Member

@irevoire irevoire commented May 30, 2023

🤖 API Diff Put the link of the GitHub comment generated by bump.sh if generated; Apply the OpenApi label


Summary

Implemented in meilisearch/meilisearch#3789

@irevoire irevoire added Ready For Review Feature specification must be reviewed. Implemented Feature specification has been implemented. 🧪 Experimental The PR describes an experimental feature. labels May 30, 2023
@irevoire irevoire requested review from macraig and gmourier May 30, 2023 13:02
Copy link
Member

@gmourier gmourier left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @irevoire 🚂

text/0174-metrics-api.md Outdated Show resolved Hide resolved
text/0174-metrics-api.md Outdated Show resolved Hide resolved
text/0174-metrics-api.md Outdated Show resolved Hide resolved
@irevoire irevoire requested a review from gmourier May 31, 2023 15:21
Copy link
Member

@gmourier gmourier left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@irevoire I just realized we have a sampleResponse field listing some metrics values under the Open API /metrics endpoint; we could either remove that sample response or update the example by including the meilisearch_ prefix. It's up to you!

text/0174-metrics-api.md Outdated Show resolved Hide resolved
open-api.yaml Outdated Show resolved Hide resolved
Copy link
Member

@gmourier gmourier left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should it be prefixed by meilisearch on every metrics?

@gmourier gmourier changed the base branch from main to release-v1.3.0 June 6, 2023 07:23
meili-bors bot added a commit to meilisearch/meilisearch that referenced this pull request Jun 6, 2023
3789: Improve the metrics r=dureuill a=irevoire

# Pull Request

## Related issue
Implements #3790
Associated specification: meilisearch/specifications#242

## Be cautious; it's DB-breaking 😱 

While reviewing and after merging this PR, be cautious; if you already have a `data.ms` and run meilisearch with this code on it, it won't work because we need to cache a new information on the index stats (that are backed up on disk). You'll get internal errors.

### About the breaking-change label

We only break the API of the metrics route, which does not pose any problem since it's experimental.

## What does this PR do?
- Create a method to get the « facet distribution » of the task queue.
- Prefix all the metrics by `meilisearch_`
- Add the real database size used by meilisearch
- Add metrics on the task queue
- Update the grafana dashboard to these new changes
- Move the dashboard to the `assets` directory
- Provide a new prometheus file to scrape meilisearch easily

Co-authored-by: Tamo <[email protected]>
@macraig macraig mentioned this pull request Jun 22, 2023
1 task
@macraig macraig merged commit b67f0d8 into release-v1.3.0 Jul 31, 2023
@macraig macraig deleted the metrics-improvements branch July 31, 2023 10:28
macraig added a commit that referenced this pull request Jul 31, 2023
* Bump openapi.yaml file

* Facet Search API (#246)

* Init specification

* Adjust spec files to PR number

* Fix content-type open-api

* Remove fix content-type

* Add the telemetry

* Update text/0246-facet-search-api.md

Co-authored-by: cvermand <[email protected]>

* Update text/0034-telemetry-policies.md

---------

Co-authored-by: Clément Renault <[email protected]>
Co-authored-by: cvermand <[email protected]>

* Faceting Setting API - sortFacetValuesBy  (#247)

* init spec

* Add property description and open-api.yaml

* Removes future possibility

* Update the telemetry

* Update the error of the sortFacetValuesBy setting

---------

Co-authored-by: Clément Renault <[email protected]>

* Vector Search - `EXPERIMENTAL` (#248)

* Init spec

* Fix the vector store fields

* Add an information on the invalid_search_vector error code

* Add an information on the invalid_vectors_field error codes

* Define the new max_vector_size analytic

* Update the open-api file with vector capabilities

* Apply suggestions from code review

* Update open-api.yaml

Co-authored-by: Maria Craig <[email protected]>

* Update open-api.yaml

Co-authored-by: Maria Craig <[email protected]>

* Update text/0118-search-api.md

Co-authored-by: Maria Craig <[email protected]>

* Update text/0061-error-format-and-definitions.md

Co-authored-by: Maria Craig <[email protected]>

---------

Co-authored-by: Kerollmops <[email protected]>
Co-authored-by: Maria Craig <[email protected]>

* Tasks route total (#253)

* Update the tasks route info to add the total field

* Update the OpenApi of the tasks route

* Document the latest metrics improvements (#242)

* document the latest metrics improvements

* Update text/0174-metrics-api.md

Co-authored-by: Guillaume Mourier <[email protected]>

* Update text/0174-metrics-api.md

Co-authored-by: Guillaume Mourier <[email protected]>

* adds some details on the meilisearch_db_size metrics

* update the open api metrics smaple

* update a bad copy paste

* Update open-api.yaml

* prefix prometheus metrics by meilisearch_

* Introduce two new metrics

---------

Co-authored-by: Guillaume Mourier <[email protected]>
Co-authored-by: Kerollmops <[email protected]>

---------

Co-authored-by: Guillaume Mourier <[email protected]>
Co-authored-by: Clément Renault <[email protected]>
Co-authored-by: cvermand <[email protected]>
Co-authored-by: Clément Renault <[email protected]>
Co-authored-by: Tamo <[email protected]>
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
🧪 Experimental The PR describes an experimental feature. Implemented Feature specification has been implemented. Ready For Review Feature specification must be reviewed. v1.3.0
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants