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

Commit

Permalink
Add a telemetry for facet distribution usage
Browse files Browse the repository at this point in the history
  • Loading branch information
gmourier committed Jul 7, 2022
1 parent 62841ee commit 953f3c2
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions text/0034-telemetry-policies.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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` |
Expand All @@ -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
Expand Down Expand Up @@ -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` |

---

Expand Down Expand Up @@ -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` |

---

Expand Down Expand Up @@ -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 |
Expand Down

0 comments on commit 953f3c2

Please sign in to comment.