Metrics API — Introduce a `/metrics` route for observability / monitoring purposes by gmourier · Pull Request #174 · meilisearch/specifications

gmourier · 2022-08-23T14:07:17Z

🤖 API Diff

Summary

Describes the /metrics endpoint dedicated for observability via Prometheus.

Changes

Add metrics-api.md
Add /metrics definition on open-api.yml
Update instance-options.md to mention --experimental-enable-metrics / MEILI_EXPERIMENTAL_ENABLE_METRICS.
Update telemetry-policies.md
- Add an instance property infos.experimental_enable_metrics
Update api-keys.md
- Add new metrics.get action (set by default on the Default Admin API key).

Out Of Scope

N/A

Attention To Reviewers

Feel free to rephrase the description of the metrics. Especially for the histogram one http_responses_time_seconds, since I'm not sure if it's clear enough.

Misc

Update OpenAPI specification file (if needed; Apply the OpenApi label)
Update telemetry datapoints (if needed; Apply the Telemetry label)

github-actions · 2022-08-24T11:48:43Z

🤖 API change detected:

Added (1)

GET /metrics

View documentation diff

Powered by Bump

gmourier · 2022-08-29T12:00:18Z

📡 Status changed for the v0.29 release.

https://github.com/meilisearch/product/issues/496#issuecomment-1230188306

gmourier · 2022-10-18T11:42:04Z

Closed for now, will be rewritten from scratch when we will work on the observability aspect.

Co-authored-by: Guillaume Mourier <guillaume@meilisearch.com>

irevoire

@dureuill & @gmourier I wrote our last change

Co-authored-by: Tamo <tamo@meilisearch.com>

gmourier

Adding clarity and transparency, it may be removed and thus never stabilized. Unsure, if it's useful to be as precise as that in the specification level. I will probably add a link to the experimental feature process to simplify it.

irevoire

👌

Kerollmops

🐇

* Bump API version * Metrics API — Introduce a `/metrics` route for observability / monitoring purposes (#174) * init spec for /metrics * Rename spec filename and add description for metrics * update metrics name and type col in the metrics table; add auth errors * Add --enable-metrics-route to instance-options.md specification * Precise metrics * update open-api.yml * Add telemetry instance property * Mention metrics route on stats.get action * Add action * Precise action description * Rephrase future possibility * Add MEILI_ENABLE_METRICS_ROUTE * rename all the cli parameter to the experimental variant * Update text/0174-metrics-api.md Co-authored-by: Guillaume Mourier <guillaume@meilisearch.com> * Update open-api.yaml Co-authored-by: Guillaume Mourier <guillaume@meilisearch.com> * Update text/0085-api-keys.md Co-authored-by: Guillaume Mourier <guillaume@meilisearch.com> * Apply suggestions from code review Co-authored-by: Tamo <tamo@meilisearch.com> --------- Co-authored-by: Tamo <tamo@meilisearch.com> * API Keys - Introduce `*` wildcard char at the last position to express access to multiple indexes starting with the same string (#189) * Bump open-api spec * Precise that the * wildcard char can be used at the last position to match multiple indexes starting with the same string * Update future possibilities * Update the index wildcard pattern error message --------- Co-authored-by: Clément Renault <clement@meilisearch.com> * Documents API — Support a csv delimiter customization (#221) * specify the support of the csv-delimiter * Apply suggestions from code review * get rid of the last 'future possibility' that is being described in this PR * Update openAPI specification --------- Co-authored-by: Guillaume Mourier <guillaume@meilisearch.com> * Update the geo-search spec to mention the fact that null is a valid geo field (#222) * GeoSearch — Add the `_geoBoundingBox` built-in filter (#223) * Add geoBoundingBox built-in filter description * Add missing parts * Update text/0059-geo-search.md Co-authored-by: Tamo <tamo@meilisearch.com> * Replace the top left / bottom right signature to a top right / bottom left signature --------- Co-authored-by: Tamo <tamo@meilisearch.com> * Search API — Add `facetStats` description (#224) * update search-api.md * rephrase * update open-api.yml * rephrase, add example on open-api.yml * Add examples * fix * Update text/0118-search-api.md Co-authored-by: Louis Dureuil <louis.dureuil@gmail.com> * rephrase * Clarify that facet stats are for all search results --------- Co-authored-by: Louis Dureuil <louis.dureuil@gmail.com> * Multi Search API (#225) * Add multi-search spec * Change possible HTTP return codes for index_not_found * Add multi-search to openAPI * Update telemetry * openAPI: shorter summary for multi-search * openAPI: attempt to remove superfluous "values" field in multisearch request/response * Apply review suggestions for openAPI Co-authored-by: Guillaume Mourier <guillaume@meilisearch.com> * Apply review suggestions for multi search API Co-authored-by: Guillaume Mourier <guillaume@meilisearch.com> * Add queries/results keys to openAPI examples Co-authored-by: Guillaume Mourier <guillaume@meilisearch.com> * fix indent * Apply review suggestions for multi search API Co-authored-by: cvermand <33010418+bidoubiwa@users.noreply.github.com> * OpenAPI: Change summary to `Multi Search` * use backticks instead of ticks in multi search API example * Apply review suggestions for multi search API Co-authored-by: Maryam <90181761+maryamsulemani97@users.noreply.github.com> * remove superfluous newline from telemetry file Co-authored-by: Guillaume Mourier <guillaume@meilisearch.com> --------- Co-authored-by: Guillaume Mourier <guillaume@meilisearch.com> Co-authored-by: cvermand <33010418+bidoubiwa@users.noreply.github.com> Co-authored-by: Maryam <90181761+maryamsulemani97@users.noreply.github.com> * Add small blurb on index count / max size (#226) --------- Co-authored-by: Tamo <tamo@meilisearch.com> Co-authored-by: Clément Renault <clement@meilisearch.com> Co-authored-by: Louis Dureuil <louis.dureuil@gmail.com> Co-authored-by: cvermand <33010418+bidoubiwa@users.noreply.github.com> Co-authored-by: Maryam <90181761+maryamsulemani97@users.noreply.github.com>

gmourier added In Progress Feature specification is in elaboration. Important changes can still occurs in the specification. v0.29 OpenAPI Update OpenAPI specification. labels Aug 23, 2022

gmourier mentioned this pull request Aug 23, 2022

Release v0.29.0 #160

Merged

1 task

gmourier added the Telemetry Update the telemetry collect. label Aug 24, 2022

gmourier requested review from Kerollmops and irevoire August 24, 2022 11:56

gmourier added Ready For Review Feature specification must be reviewed. and removed In Progress Feature specification is in elaboration. Important changes can still occurs in the specification. labels Aug 24, 2022

gmourier changed the title ~~Metrics API — WIP~~ Metrics API — Introduce a /metrics route for observability / monitoring purposes Aug 24, 2022

Kerollmops reviewed Aug 24, 2022

View reviewed changes

Comment thread text/0085-api-keys.md Outdated

This was referenced Aug 25, 2022

Add /metrics route - BETA meilisearch/meilisearch#2704

Closed

Polish the /metrics route feature meilisearch/meilisearch#2706

Closed

gmourier removed Ready For Review Feature specification must be reviewed. v0.29 labels Aug 29, 2022

gmourier added the In Progress Feature specification is in elaboration. Important changes can still occurs in the specification. label Aug 29, 2022

maryamsulemani97 mentioned this pull request Sep 5, 2022

v0.29: Telemetry updates meilisearch/documentation#1836

Closed

gmourier removed the In Progress Feature specification is in elaboration. Important changes can still occurs in the specification. label Sep 26, 2022

gmourier closed this Oct 18, 2022

Kerollmops deleted the add-spec-for-beta-metrics-endpoint branch October 18, 2022 16:23

gmourier restored the add-spec-for-beta-metrics-endpoint branch February 21, 2023 11:04

gmourier reopened this Feb 21, 2023

gmourier changed the title ~~Metrics API — Introduce a /metrics route for observability / monitoring purposes~~ EXPERIMENTAL Metrics API — Introduce a /metrics route for observability / monitoring purposes Feb 21, 2023

gmourier changed the title ~~EXPERIMENTAL Metrics API — Introduce a /metrics route for observability / monitoring purposes~~ 🧪 EXPERIMENTAL Metrics API — Introduce a /metrics route for observability / monitoring purposes Feb 21, 2023

gmourier changed the base branch from develop to release-v1.1.0 February 21, 2023 11:05

gmourier mentioned this pull request Feb 21, 2023

Release v1.1.0 #220

Merged

1 task

curquiza mentioned this pull request Feb 21, 2023

Experimental feature: Metrics meilisearch/meilisearch#3523

Closed

gmourier added 6 commits February 22, 2023 11:28

Add telemetry instance property

cfffdc7

Mention metrics route on stats.get action

7b7f5c0

Add action

7de05c6

Precise action description

77be1fc

Rephrase future possibility

17edb7f

Add MEILI_ENABLE_METRICS_ROUTE

4b5f7c7

irevoire force-pushed the add-spec-for-beta-metrics-endpoint branch from 919a02a to 4b5f7c7 Compare February 22, 2023 10:30

gmourier commented Feb 22, 2023

View reviewed changes

Comment thread open-api.yaml Outdated

gmourier commented Feb 22, 2023

View reviewed changes

Comment thread text/0085-api-keys.md Outdated

rename all the cli parameter to the experimental variant

3154ac0

irevoire force-pushed the add-spec-for-beta-metrics-endpoint branch from e19f840 to 3154ac0 Compare February 22, 2023 10:53

gmourier commented Feb 22, 2023

View reviewed changes

Comment thread text/0174-metrics-api.md Outdated

irevoire and others added 3 commits February 22, 2023 12:02

Update text/0174-metrics-api.md

c2248bc

Co-authored-by: Guillaume Mourier <guillaume@meilisearch.com>

Update open-api.yaml

09e8aef

Co-authored-by: Guillaume Mourier <guillaume@meilisearch.com>

Update text/0085-api-keys.md

32f7be2

Co-authored-by: Guillaume Mourier <guillaume@meilisearch.com>

irevoire suggested changes Feb 23, 2023

View reviewed changes

Comment thread text/0174-metrics-api.md Outdated

Comment thread text/0085-api-keys.md Outdated

Apply suggestions from code review

b697491

Co-authored-by: Tamo <tamo@meilisearch.com>

gmourier commented Feb 23, 2023

View reviewed changes

Comment thread text/0174-metrics-api.md

gmourier added Ready For Review Feature specification must be reviewed. and removed In Progress Feature specification is in elaboration. Important changes can still occurs in the specification. labels Feb 23, 2023

gmourier added the Q1:2023 label Mar 3, 2023

brunoocasali mentioned this pull request Mar 8, 2023

Changes regarding Meilisearch v1.1.0 meilisearch/integration-guides#251

Closed

guimachiavelli mentioned this pull request Mar 8, 2023

v1.1: Experimental /metrics endpoint meilisearch/documentation#2206

Closed

3 tasks

irevoire approved these changes Mar 13, 2023

View reviewed changes

guimachiavelli mentioned this pull request Mar 13, 2023

v1.1: Telemetry table updates meilisearch/documentation#2202

Closed

8 tasks

Kerollmops approved these changes Mar 15, 2023

View reviewed changes

gmourier removed the Ready For Review Feature specification must be reviewed. label Mar 22, 2023

gmourier merged commit 6d9a5fd into release-v1.1.0 Apr 3, 2023

gmourier deleted the add-spec-for-beta-metrics-endpoint branch April 3, 2023 14:13

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Metrics API — Introduce a `/metrics` route for observability / monitoring purposes#174

Metrics API — Introduce a `/metrics` route for observability / monitoring purposes#174
gmourier merged 17 commits intorelease-v1.1.0from
add-spec-for-beta-metrics-endpoint

gmourier commented Aug 23, 2022 •

edited

Loading

Uh oh!

github-actions Bot commented Aug 24, 2022 •

edited

Loading

Uh oh!

Uh oh!

gmourier commented Aug 29, 2022 •

edited

Loading

Uh oh!

gmourier commented Oct 18, 2022 •

edited

Loading

Uh oh!

Uh oh!

Uh oh!

Uh oh!

irevoire left a comment

Uh oh!

Uh oh!

Uh oh!

gmourier left a comment •

edited

Loading

Uh oh!

Uh oh!

irevoire left a comment

Uh oh!

Kerollmops left a comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Conversation

gmourier commented Aug 23, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Changes

Out Of Scope

Attention To Reviewers

Misc

Uh oh!

github-actions Bot commented Aug 24, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Added (1)

Uh oh!

Uh oh!

gmourier commented Aug 29, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

gmourier commented Oct 18, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

irevoire left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

gmourier left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

irevoire left a comment

Choose a reason for hiding this comment

Uh oh!

Kerollmops left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

gmourier commented Aug 23, 2022 •

edited

Loading

github-actions Bot commented Aug 24, 2022 •

edited

Loading

gmourier commented Aug 29, 2022 •

edited

Loading

gmourier commented Oct 18, 2022 •

edited

Loading

gmourier left a comment •

edited

Loading