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

Add usage metrics for the tasks endpoints #92

Merged
merged 1 commit into from
Nov 24, 2021
Merged

Add usage metrics for the tasks endpoints #92

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
17 changes: 17 additions & 0 deletions text/0034-telemetry-policies.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,8 @@ The collected data is sent to [Segment](https://segment.com/). Segment is a plat
| FilterableAttributes Updated | Occurs when filterable attributes are updated via `POST` - `/indexes/:indexUid/settings/filterable-attributes`. |
| SortableAttributes Updated | Occurs when sortable attributes are updated via `POST` - `/indexes/:indexUid/settings/sortable-attributes`. |
| Dump Created | Occurs when a dump is created via `POST` - `/dumps`. |
| Tasks Seen | Occurs when tasks are fetched globally via `GET` - `/tasks`. |
| Index Tasks Seen | Occurs when tasks are filtered by index via `GET` - `/indexes/:indexUid/tasks`. |
----

#### Summarized Metrics/Events table
Expand Down Expand Up @@ -94,6 +96,7 @@ The collected data is sent to [Segment](https://segment.com/). Segment is a plat
| `filterable_attributes.total` | Number of filterable attributes | 3 | `Settings Updated`, `FilterableAttributes Updated` |
| `filterable_attributes.has_geo` | `true` if `_geo` is set as a filterable attribute, otherwise `false` | false | `Settings Updated`, `FilterableAttributes Updated`|
| `searchable_attributes.total` | Number of searchable attributes | 4 | `Settings Updated`, `SearchableAttributes Update` |
| `per_task_uid` | `true` if an uid is used to fetch a particular task resource, otherwise `false` | true | `Tasks Seen`, `Index Tasks Seen` |

----

Expand Down Expand Up @@ -277,6 +280,20 @@ This property allows us to gather essential information to better understand on
|---------------|-------------|---------|
| user_agent | Represents the user-agent encountered on this call. | ["MeiliSearch Ruby (2.1)", "Ruby (3.0)"] |

## `Tasks Seen`

| Property name | Description | Example |
|---------------|-------------|---------|
| user_agent | Represents the user-agent encountered on this call. | ["MeiliSearch Ruby (2.1)", "Ruby (3.0)"] |
| per_task_uid | `true` if an uid is used to fetch a particular task resource, otherwise `false` | `true` |

## `Index Tasks Seen`

| Property name | Description | Example |
|---------------|-------------|---------|
| user_agent | Represents the user-agent encountered on this call. | ["MeiliSearch Ruby (2.1)", "Ruby (3.0)"] |
| per_task_uid | `true` if an uid is used to fetch a particular task resource, otherwise `false` | `true` |

---

#### User-interface
Expand Down