meilisearch / meilisearch/documentation

Telemetry reference omits 16 experimental_* fields the engine actually sends

Open Beginner friendly
#3,627 0 comments 0 reactions 0 assignees View on GitHub

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 Infos struct in
    crates/meilisearch/src/analytics/segment_analytics.rs (#[derive(Serialize)]; its own doc-comment says "the infos field we send in the analytics … sent as-is in amplitude"). It goes into compute_traits → the identify traits.
  • Documented: experimental_ names in resources/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_networks
  • experimental_chat_completions
  • experimental_drop_search_after
  • experimental_dynamic_search_rules
  • experimental_foreign_keys
  • experimental_get_task_documents_route
  • experimental_legacy_search
  • experimental_limit_batched_tasks_total_size
  • experimental_max_number_of_batched_tasks
  • experimental_nb_searches_per_core
  • experimental_no_edition_2024_for_dumps
  • experimental_no_snapshot_compaction
  • experimental_personalization
  • experimental_queue_documents_fetch
  • experimental_render_route
  • experimental_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

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. 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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.