From 953f3c278469af5e86b13ec330bc8772c0dd2091 Mon Sep 17 00:00:00 2001 From: Guillaume Mourier Date: Wed, 18 May 2022 15:32:25 +0200 Subject: [PATCH] Add a telemetry for facet distribution usage --- text/0034-telemetry-policies.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/text/0034-telemetry-policies.md b/text/0034-telemetry-policies.md index 407ece3c..910720ae 100644 --- a/text/0034-telemetry-policies.md +++ b/text/0034-telemetry-policies.md @@ -35,7 +35,6 @@ The collected data is sent to [Segment](https://segment.com/). Segment is a plat [Amplitude](https://amplitude.com/) is a tool for graphing and highlighting collected data. Segment feeds Amplitude so that we can build visualizations according to our needs. - ---- #### Events table @@ -114,6 +113,7 @@ The collected data is sent to [Segment](https://segment.com/). Segment is a plat | `formatting.crop_length` | `true` if `cropLength` was used in this batch, otherwise `false` | false | `Documents Searched POST`, `Documents Searched GET` | | `formatting.crop_marker` | `true` if `cropMarker` was used in this batch, otherwise `false` | false | `Documents Searched POST`, `Documents Searched GET` | | `formatting.show_matches_position` | `true` if `showMatchesPosition` was used in this batch, otherwise `false` | false | `Documents Searched POST`, `Documents Searched GET` | +| `facets` | `true` if `facets` was used in this batch, otherwise `false` | false | `Documents Searched POST`, `Documents Searched GET` | | `primary_key` | Value given for the `primaryKey` parameter if used, otherwise `null` | id | `Index Created`, `Index Updated`, `Documents Added`, `Documents Updated`| | `payload_type` | All `payload_type` encountered in this batch | ["application/json", "text/plain", "application/x-ndjson"] | `Documents Added`, `Documents Updated` | | `index_creation` | `true` if a document addition or update request triggered index creation in this batch, otherwise `false` | true | `Documents Added`, `Documents Updated` | @@ -133,7 +133,6 @@ The collected data is sent to [Segment](https://segment.com/). Segment is a plat | `filtered_by_type` | `true` if `GET /tasks` endpoint is filered by `type`, otherwise `false` | false | `Tasks Seen` | | `filtered_by_status` | `true` if `GET /tasks` endpoint is filered by `status`, otherwise `false` | false | `Tasks Seen` | - ---- #### Detailed list of Instance metrics and, events with their metrics @@ -219,6 +218,7 @@ This property allows us to gather essential information to better understand on | formatting.crop_length | Does `cropLength` has been used in the aggregated event? If yes, `true` otherwise `false` | `false` | | formatting.crop_marker | Does `cropMarker` has been used in the aggregated event? If yes, `true` otherwise `false` | `false` | | formatting.show_matches_position | Does `showMatchesPosition` has been used in the aggregated event? If yes, `true` otherwise `false` | `false` | +| facets | Does `facets` has been used in the aggregated event? If yes, `true` otherwise `false` | `false` | --- @@ -246,6 +246,7 @@ This property allows us to gather essential information to better understand on | formatting.crop_length | Does `cropLength` has been used in the aggregated event? If yes, `true` otherwise `false` | `false` | | formatting.crop_marker | Does `cropMarker` has been used in the aggregated event? If yes, `true` otherwise `false` | `false` | | formatting.show_matches_position | Does `showMatchesPosition` has been used in the aggregated event? If yes, `true` otherwise `false` | `false` | +| facets | Does `facets` has been used in the aggregated event? If yes, `true` otherwise `false` | `false` | --- @@ -347,7 +348,6 @@ This property allows us to gather essential information to better understand on | user_agent | Represents the user-agent encountered on this call. | `["Meilisearch Ruby (v2.1)", "Ruby (3.0)"]` | | searchable_attributes.total | Number of searchable attributes. | `3` | - ## `TypoTolerance Updated` | Property name | Description | Example |