Adjust telemetry user‑facing messages

XMLWordPrintableJSON

    • Type: Task
    • Resolution: Done
    • Priority: Major - P3
    • 2.11.1
    • Affects Version/s: None
    • Component/s: None
    • None
    • Needed
    • Hide

      The current ticket changes the welcome message only, but we should adjust any user‑facing messages that mention telemetry.

      • For the Configure mongosh page, I would change “anonymous” to “pseudo-anonymous”, since we track the device_id. In our conversation with Legal, we agreed that we should describe things as clearly as possible without going into too much detail. I would probably also add “Data collection (interactive and agentic sessions only),” since we do not currently collect data from scripted sessions. Users may prefer knowing that their scripts are telemetry-free without having to check which setting they currently have.
      • With the new telemetry design, if the telemetry endpoint is unavailable and telemetry is enabled in the user’s settings, the telemetry payload is written to the log. Previously, only event names and some metadata, such as the timestamp and context, were written. I am not sure whether we want to call this out explicitly for users in the Shell Logs documenation, or whether it is not relevant because the data is not sent over the network to a telemetry endpoint.
      • For the Configure Telemetry Options page, we also need new copy explaining what mongosh tracks and what it does not track. We should once again mention that mongosh collects “pseudo-anonymous” data. We also track IP addresses (although we do not store them), and that telemetry collection is limited to interactive and agentic sessions.
      • For the Configure Shell Settings page and the corresponding English localization strings, we should make the same update: describe the data as “pseudo-anonymous” and clarify that telemetry is collected only during interactive and agentic sessions.
      Show
      The current ticket changes the welcome message only, but we should adjust any user‑facing messages that mention telemetry. For the  Configure mongosh  page, I would change “anonymous” to “pseudo-anonymous”, since we track the  device_id . In our conversation with Legal, we agreed that we should describe things as clearly as possible without going into too much detail. I would probably also add “Data collection (interactive and agentic sessions only),” since we do not currently collect data from scripted sessions. Users may prefer knowing that their scripts are telemetry-free without having to check which setting they currently have. With the new telemetry design, if the telemetry endpoint is unavailable and telemetry is enabled in the user’s settings, the telemetry payload is written to the log. Previously, only event names and some metadata, such as the timestamp and context, were written. I am not sure whether we want to call this out explicitly for users in the  Shell Logs  documenation, or whether it is not relevant because the data is not sent over the network to a telemetry endpoint. For the  Configure Telemetry Options  page, we also need new copy explaining what mongosh tracks and what it does not track. We should once again mention that mongosh collects “pseudo-anonymous” data. We also track IP addresses (although we do not store them), and that telemetry collection is limited to interactive and agentic sessions. For the  Configure Shell Settings  page and the corresponding  English localization strings , we should make the same update: describe the data as “pseudo-anonymous” and clarify that telemetry is collected only during interactive and agentic sessions.
    • Developer Tools

      Adjust mongosh startup message https://github.com/mongodb-js/mongosh/blob/main/packages/i18n/src/locales/en_US.ts#L102-L119.

      Find documentation that also needs to be adjusted in comment down below.

            Assignee:
            Alena Khineika
            Reporter:
            Alena Khineika
            Votes:
            0 Vote for this issue
            Watchers:
            2 Start watching this issue

              Created:
              Updated:
              Resolved: