meilisearch / meilisearch/documentation
Telemetry reference omits 16 experimental_* fields the engine actually sends
Nobody has claimed this yet.
- Dominant language
- MDX
- Stars
- 174
- Forks
- 276
- Avg merge
- 2d 1h
- Merged PRs (30d)
- 6
Description
Summary
The telemetry reference (resources/help/telemetry.mdx) lists 14 experimental_* fields under
infos, but the engine's Infos struct — the thing actually serialized into the infos telemetry
payload — currently emits 30. So 16 experimental_* fields are collected but not listed on the
telemetry page. Since that page is what a privacy-conscious operator reads to decide whether to run
with telemetry on, it seemed worth reconciling.
I know the page already says "This list is liable to change with every new version" — this is just
to help it catch up, not a gotcha.
How I checked (reproducible)
- Emitted (source of truth): the
Infosstruct in
crates/meilisearch/src/analytics/segment_analytics.rs(#[derive(Serialize)]; its own doc-comment says "theinfosfield we send in the analytics … sent as-is in amplitude"). It goes intocompute_traits→ the identifytraits. - Documented:
experimental_names inresources/help/telemetry.mdx@3060253e7. - Diffing the two sets: 30 emitted − 14 documented = 16 emitted but not documented (and 0 documented-but-not-emitted).
The 16 experimental_* fields sent but not on the telemetry page
experimental_allowed_ip_networksexperimental_chat_completionsexperimental_drop_search_afterexperimental_dynamic_search_rulesexperimental_foreign_keysexperimental_get_task_documents_routeexperimental_legacy_searchexperimental_limit_batched_tasks_total_sizeexperimental_max_number_of_batched_tasksexperimental_nb_searches_per_coreexperimental_no_edition_2024_for_dumpsexperimental_no_snapshot_compactionexperimental_personalizationexperimental_queue_documents_fetchexperimental_render_routeexperimental_task_queue_compaction_route
(All under infos. in the payload, same as the documented ones.)
Suggested fix
Add these rows to the infos section of the telemetry page. I'd be glad to open the PR — just wanted
to confirm the list with you first, since a couple (e.g. experimental_chat_completions,
experimental_personalization, experimental_render_route) look like recently-added features.
Disclosure (per your CONTRIBUTING): this was prepared with the help of a generative-AI coding
tool (Claude Code). I verified every claim myself — the 16-field delta is a mechanical diff of the two
cited, SHA-pinned sources above — and I own this contribution.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Compare the Infos struct in crates/meilisearch/src/analytics/segment_analytics.rs with the infos section in resources/help/telemetry.mdx, using the cited source revisions as the starting point. Add the 16 missing experimental_* rows and verify that the page documents all 30 emitted fields with no omissions.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- rust
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Quiet
- Clarity
- Clearly specified
- Newbie friendliness
- 82/100