From a1ceb5f931f356696827d12e7e430c316467a025 Mon Sep 17 00:00:00 2001 From: Guillaume Mourier Date: Mon, 16 May 2022 18:32:11 +0200 Subject: [PATCH] Telemetry - Add `x-meilisearch-client` query parameter (#145) * Introduce the x-meilisearch-client query parameter * Update text/0034-telemetry-policies.md Co-authored-by: Bruno Casali * Update text/0034-telemetry-policies.md Co-authored-by: Bruno Casali Co-authored-by: Bruno Casali --- text/0034-telemetry-policies.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/text/0034-telemetry-policies.md b/text/0034-telemetry-policies.md index 38206365..76913eb5 100644 --- a/text/0034-telemetry-policies.md +++ b/text/0034-telemetry-policies.md @@ -417,6 +417,12 @@ The `User-Agent` header is tracked on the events listed below. Our official SDKs Each endpoint API tracked sends the `User-Agent` as a `user_agent` event property as an array. If several values are contained in the `User-Agent` header, they are split by the `;` character. +##### `x-meilisearch-client` Query Parameter + +Some browser engines prevent overloading the User-Agent header. To track the calls made by some clients concerned by this fact, e.g. the JavaScript SDK, it is possible to use the `x-meilisearch-client` query parameter. + +If the query parameter is encountered, it overrides the presence of the `User-Agent` header. + #### Identifying MeiliSearch installation To identify instances, we generate a unique identifier at first launch if analytics are not disabled.