new telemetry docs #1999
new telemetry docs #1999
Conversation
WalkthroughThe changes introduce updates to the telemetry documentation. A new file, telemetry-old.mdx, details the legacy telemetry system by documenting data collection procedures, frequency, and user opt-out options, including the use of a randomly generated client identifier. The updated telemetry.mdx file revises the existing telemetry documentation by renaming the title, adding a "tl;dr" summary, and incorporating new sections that outline event types and properties. These changes clarify the specifics of the collected telemetry data—such as usage metrics, app activities, and error reports—and provide detailed instructions for disabling telemetry. The documentation emphasizes that no personal information, keystrokes, file contents, or IP addresses are collected, and the revisions standardize the formatting and presentation of the telemetry processes. Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 2
🧹 Nitpick comments (3)
docs/docs/telemetry.mdx (2)
27-35: Enhanced Telemetry Toggle InstructionsThe tip block effectively guides users on how to change their telemetry settings using the wsh command. For further clarity, you might consider adding an example of expected output or a brief note on troubleshooting if the command fails.
122-124: Punctuation Improvement in the IP Addresses NoteIn the sentence "We do not store your IP address in our telemetry table and do not associate it with your ClientId," adding a comma before "and" could improve readability. Consider updating this sentence to:
"We do not store your IP address in our telemetry table, and do not associate it with your ClientId."docs/docs/telemetry-old.mdx (1)
1-5: Header Metadata for Legacy TelemetryThe front matter is clear with the ID and title ("Legacy Telemetry") set appropriately, and the sidebar is hidden as required. For consistency with the new telemetry documentation, consider using the same title formatting (either with or without quotes) across files.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (2)
docs/docs/telemetry-old.mdx(1 hunks)docs/docs/telemetry.mdx(2 hunks)
🧰 Additional context used
🪛 LanguageTool
docs/docs/telemetry-old.mdx
[uncategorized] ~29-~29: Possible missing comma found.
Context: ...metry is enabled, a telemetry update is sent regardless of how long it has been sinc...
(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~33-~33: Possible missing comma found.
Context: .... The timer still runs in the background but no data is sent. ### When Waveterm is ...
(AI_HYDRA_LEO_MISSING_COMMA)
[grammar] ~50-~50: Possible agreement error.
Context: ...cks | The number of existing blocks open on a given day ...
(AGREEMENT_SENT_START)
[grammar] ~51-~51: Possible agreement error.
Context: ...abs | The number of existing tabs open on a given day. ...
(AGREEMENT_SENT_START)
[uncategorized] ~77-~77: Did you mean the adverb “anymore”?
Context: ... will not be sent up with the telemetry any more. | | TzName | The code for the t...
(ANY_MORE)
[style] ~95-~95: Consider shortening this phrase to just ‘whether’, unless you mean ‘regardless of whether’.
Context: ... | | AutoUpdateEnabled | Whether or not auto update is turned on. ...
(WHETHER)
[uncategorized] ~95-~95: It appears that a hyphen is missing (if ‘auto’ is not used in the context of ‘cars’).
Context: ... | | AutoUpdateEnabled | Whether or not auto update is turned on. ...
(AUTO_HYPHEN)
[uncategorized] ~96-~96: It appears that a hyphen is missing (if ‘auto’ is not used in the context of ‘cars’).
Context: ... | | AutoUpdateChannel | The type of auto update in use. This specifically refers to whe...
(AUTO_HYPHEN)
[uncategorized] ~118-~118: Possible missing comma found.
Context: ... store your IP address in our telemetry table and do not associate it with your _...
(AI_HYDRA_LEO_MISSING_COMMA)
docs/docs/telemetry.mdx
[uncategorized] ~78-~78: Use a comma before ‘but’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...error` | Logged when you try to connect but it fails (logs the connection type, no ...
(COMMA_COMPOUND_SENTENCE)
[grammar] ~91-~91: Possibly, a comma is missing after an introductory clause, the verb inflection is not correct, or a question mark is missing. Did you mean “dev, build” or “dev builds”?
Context: ...ev` | True/False if using the dev build ...
(IF_DT_NN_VBZ)
⏰ Context from checks skipped due to timeout of 90000ms (5)
- GitHub Check: Analyze (javascript-typescript)
- GitHub Check: Build Docsite
- GitHub Check: Analyze (go)
- GitHub Check: merge-gatekeeper
- GitHub Check: Build for TestDriver.ai
🔇 Additional comments (8)
docs/docs/telemetry.mdx (4)
3-3: Title Formatting ConsistencyThe title "Telemetry" is now updated without quotes, which aligns with our standard YAML front matter style. Please ensure consistent formatting across all documentation files.
7-10: Introduction of the New “tl;dr” SectionThe addition of the "tl;dr" section provides a concise summary of the collected telemetry data and clearly states that no personal information (PII) is gathered. This enhances clarity and transparency for the users.
37-41: Informative Context on the New Telemetry SystemThe info block clearly explains the scope of the new telemetry system and directs users to the legacy documentation. This contextual information is valuable in helping users understand the evolution of the telemetry processes.
1-130: Overall Documentation StructuringThe document is well structured and the enhancements—including the new sections on event types, event properties, and clarity around data collection practices—provide comprehensive and accessible information. Please continue to ensure that punctuation, formatting, and terminology remain consistent across similar sections.
🧰 Tools
🪛 LanguageTool
[uncategorized] ~78-~78: Use a comma before ‘but’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...error` | Logged when you try to connect but it fails (logs the connection type, no ...(COMMA_COMPOUND_SENTENCE)
[grammar] ~91-~91: Possibly, a comma is missing after an introductory clause, the verb inflection is not correct, or a question mark is missing. Did you mean “dev, build” or “dev builds”?
Context: ...ev` | True/False if using the dev build ...(IF_DT_NN_VBZ)
docs/docs/telemetry-old.mdx (4)
7-9: Clear Description of Legacy TelemetryThe opening paragraph succinctly explains the purpose of legacy telemetry data collection and the privacy measures in place (no PII is collected). This aligns well with our overarching commitment to user privacy.
11-19: Telemetry Setting Instructions ClarificationThe info block provides clear instructions on changing telemetry settings using the wsh command. This mirrors the approach used in the new telemetry documentation and is effective in guiding users.
21-38: Consistent Explanation of Telemetry Sending ProcessThe sections detailing when telemetry is sent (i.e., once enabled, when disabled, and on application close) are clear and mirror the structure from the new telemetry documentation. This consistency helps maintain coherence between legacy and current systems.
🧰 Tools
🪛 LanguageTool
[uncategorized] ~29-~29: Possible missing comma found.
Context: ...metry is enabled, a telemetry update is sent regardless of how long it has been sinc...(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~33-~33: Possible missing comma found.
Context: .... The timer still runs in the background but no data is sent. ### When Waveterm is ...(AI_HYDRA_LEO_MISSING_COMMA)
39-131: Overall Legacy Telemetry DocumentationThe remainder of the document—covering associated data, telemetry metadata, geo data, and additional details—provides a comprehensive overview of the legacy telemetry system. Minor tweaks in punctuation and phrasing, similar to those suggested for the new telemetry docs, could further enhance clarity.
🧰 Tools
🪛 LanguageTool
[grammar] ~50-~50: Possible agreement error.
Context: ...cks | The number of existing blocks open on a given day ...(AGREEMENT_SENT_START)
[grammar] ~51-~51: Possible agreement error.
Context: ...abs | The number of existing tabs open on a given day. ...(AGREEMENT_SENT_START)
[uncategorized] ~77-~77: Did you mean the adverb “anymore”?
Context: ... will not be sent up with the telemetry any more. | | TzName | The code for the t...(ANY_MORE)
[style] ~95-~95: Consider shortening this phrase to just ‘whether’, unless you mean ‘regardless of whether’.
Context: ... | | AutoUpdateEnabled | Whether or not auto update is turned on. ...(WHETHER)
[uncategorized] ~95-~95: It appears that a hyphen is missing (if ‘auto’ is not used in the context of ‘cars’).
Context: ... | | AutoUpdateEnabled | Whether or not auto update is turned on. ...(AUTO_HYPHEN)
[uncategorized] ~96-~96: It appears that a hyphen is missing (if ‘auto’ is not used in the context of ‘cars’).
Context: ... | | AutoUpdateChannel | The type of auto update in use. This specifically refers to whe...(AUTO_HYPHEN)
[uncategorized] ~118-~118: Possible missing comma found.
Context: ... store your IP address in our telemetry table and do not associate it with your _...(AI_HYDRA_LEO_MISSING_COMMA)
| | `action:createblock` | Logged when a new block is created (contains the block view type) | | ||
| | `wsh:run` | Logged when a wsh command is executed (contains the command type) | | ||
| | `debug:panic` | Logged when a backend (Go) panic happens. Contains a debugging string that can be used to find which panic was hit in our source code. No data is sent | | ||
| | `conn:connect` | Logged each time a backend ssh/wsl connection connects (logs the conneciton type, no hostname or IP is sent) | |
There was a problem hiding this comment.
Typographical Error in Event Description
There is a typo in the description for the conn:connect event. Please change "conneciton" to "connection" for professionalism and clarity.
- | `conn:connect` | Logged each time a backend ssh/wsl connection connects (logs the conneciton type, no hostname or IP is sent)
+ | `conn:connect` | Logged each time a backend ssh/wsl connection connects (logs the connection type, no hostname or IP is sent)📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| | `conn:connect` | Logged each time a backend ssh/wsl connection connects (logs the conneciton type, no hostname or IP is sent) | | |
| | `conn:connect` | Logged each time a backend ssh/wsl connection connects (logs the connection type, no hostname or IP is sent) |
docs/docs/telemetry-old.mdx
Outdated
| | Name | Description | | ||
| | ------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ||
| | ActiveMinutes | The number of minutes that the user has actively used Waveterm on a given day. This requires the terminal window to be in focus while the user is actively interacting with it. | | ||
| | FgMinutes | The number of minutes that Waveterm has been in the foreground on a given day. This requires the terminal window to be in focus regardless of user interaction. | | ||
| | OpenMinutes | The number of minutes that Waveterm has been open on a given day. This only requires that the terminal is open, even if the window is out of focus. | | ||
| | NumBlocks | The number of existing blocks open on a given day | | ||
| | NumTabs | The number of existing tabs open on a given day. | | ||
| | NewTab | The number of new tabs created on a given day | | ||
| | NumWindows | The number of existing windows open on a given day. | | ||
| | NumWS | The number of existing workspaces on a given day. | | ||
| | NumWSNamed | The number of named workspaces on a give day. | | ||
| | NewTab | The number of new tabs opened on a given day. | |
There was a problem hiding this comment.
Duplicate Entry in Telemetry Data Table
Within the telemetry data table, the row for "NewTab" appears twice. Please verify if this duplication is intentional. If it is an oversight, consider removing one of the duplicate entries to avoid confusion.
- | NewTab | The number of new tabs opened on a given day.📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| | Name | Description | | |
| | ------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | |
| | ActiveMinutes | The number of minutes that the user has actively used Waveterm on a given day. This requires the terminal window to be in focus while the user is actively interacting with it. | | |
| | FgMinutes | The number of minutes that Waveterm has been in the foreground on a given day. This requires the terminal window to be in focus regardless of user interaction. | | |
| | OpenMinutes | The number of minutes that Waveterm has been open on a given day. This only requires that the terminal is open, even if the window is out of focus. | | |
| | NumBlocks | The number of existing blocks open on a given day | | |
| | NumTabs | The number of existing tabs open on a given day. | | |
| | NewTab | The number of new tabs created on a given day | | |
| | NumWindows | The number of existing windows open on a given day. | | |
| | NumWS | The number of existing workspaces on a given day. | | |
| | NumWSNamed | The number of named workspaces on a give day. | | |
| | NewTab | The number of new tabs opened on a given day. | | |
| | Name | Description | | |
| | ------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | |
| | ActiveMinutes | The number of minutes that the user has actively used Waveterm on a given day. This requires the terminal window to be in focus while the user is actively interacting with it. | | |
| | FgMinutes | The number of minutes that Waveterm has been in the foreground on a given day. This requires the terminal window to be in focus regardless of user interaction. | | |
| | OpenMinutes | The number of minutes that Waveterm has been open on a given day. This only requires that the terminal is open, even if the window is out of focus. | | |
| | NumBlocks | The number of existing blocks open on a given day | | |
| | NumTabs | The number of existing tabs open on a given day. | | |
| | NewTab | The number of new tabs created on a given day | | |
| | NumWindows | The number of existing windows open on a given day. | | |
| | NumWS | The number of existing workspaces on a given day. | | |
| | NumWSNamed | The number of named workspaces on a give day. | |
🧰 Tools
🪛 LanguageTool
[grammar] ~50-~50: Possible agreement error.
Context: ...cks | The number of existing blocks open on a given day ...
(AGREEMENT_SENT_START)
[grammar] ~51-~51: Possible agreement error.
Context: ...abs | The number of existing tabs open on a given day. ...
(AGREEMENT_SENT_START)
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (2)
docs/docs/telemetry.mdx (2)
11-20: Telemetry Data Summary and Bullet List
The quick summary and accompanying bullet list effectively enumerate the types of telemetry data collected—including basic app/system info, usage metrics, feature interactions, display details, connection events, AI commands, and error reports. Consider a minor punctuation tweak: for instance, changing “every 4-hours” to “every 4 hours” for consistency.
80-118: Detailed Event Properties Table
The event properties table is comprehensive and clearly outlines the metadata associated with various telemetry events. As a minor enhancement, consider adding a comma to the description forclient:isdev(line 91) for improved readability (e.g., “True/False, if using the dev build”).🧰 Tools
🪛 LanguageTool
[grammar] ~91-~91: Possibly, a comma is missing after an introductory clause, the verb inflection is not correct, or a question mark is missing. Did you mean “dev, build” or “dev builds”?
Context: ...ev` | True/False if using the dev build ...(IF_DT_NN_VBZ)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
docs/docs/telemetry.mdx(2 hunks)
🧰 Additional context used
🪛 LanguageTool
docs/docs/telemetry.mdx
[uncategorized] ~78-~78: Use a comma before ‘but’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...error` | Logged when you try to connect but it fails (logs the connection type, no ...
(COMMA_COMPOUND_SENTENCE)
[grammar] ~91-~91: Possibly, a comma is missing after an introductory clause, the verb inflection is not correct, or a question mark is missing. Did you mean “dev, build” or “dev builds”?
Context: ...ev` | True/False if using the dev build ...
(IF_DT_NN_VBZ)
⏰ Context from checks skipped due to timeout of 90000ms (3)
- GitHub Check: Build for TestDriver.ai
- GitHub Check: Analyze (javascript-typescript)
- GitHub Check: Analyze (go)
🔇 Additional comments (6)
docs/docs/telemetry.mdx (6)
1-5: Frontmatter Update: Title and Sidebar Position
The updated frontmatter now specifiestitle: Telemetrywithout quotes, which aligns with our updated documentation style. The sidebar position remains properly set.
7-10: New TL;DR Section Added
The new## tl;drsection succinctly summarizes the telemetry data collection practices and explicitly states that no personal information (PII), keystrokes, file contents, AI prompts, IP addresses, hostnames, or commands are collected.
21-26: Clear Instructions for Disabling Telemetry
The updated instructions under the "## How to Disable Telemetry" section clearly explain how to toggle telemetry via the welcome page and the configuration file. The clarity of these instructions is commendable.
27-35: Enhanced Tip Block for Changing Telemetry Settings
The:::tipblock offers an additional, user-friendly method for adjusting telemetry settings using thewsh setconfigcommand. The formatting and explicit command example enhance usability.
37-41: Informative Info Block on Telemetry Context
The:::infoblock clearly contextualizes the document by indicating that it pertains to the new telemetry system (v0.11.1) and points users to the legacy documentation for reference. It might be worthwhile to periodically verify that the version number remains current.
59-79: Comprehensive Event Types Section
The newly added "## Event Types" section provides a detailed and organized table of event types. However, note the following:
- In the description for
conn:connect(line 77), "conneciton" is misspelled; please correct it to "connection" (this issue was flagged in previous reviews).- In the description for
conn:connecterror(line 78), consider inserting a comma before "but" to improve clarity, e.g., “Logged when you try to connect, but it fails…”🧰 Tools
🪛 LanguageTool
[uncategorized] ~78-~78: Use a comma before ‘but’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...error` | Logged when you try to connect but it fails (logs the connection type, no ...(COMMA_COMPOUND_SENTENCE)
No description provided.