Skip to content

Better telemetry #1608

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jul 10, 2025
Merged

Conversation

isc-bsaviano
Copy link
Contributor

@isc-bsaviano isc-bsaviano commented Jul 9, 2025

Currently this extension collects very little telemetry. Better telemetry will help InterSystems identity and prioritize enhancements that will make the most impact for our users. The top level bullet points correspond to telemetry events, and the second level corresponds to the properties sent for that event.

  • extensionActivated Sent when extension is activated.
    • languageServerVersion May be undefined.
    • serverManagerVersion
    • config.explorer.alwaysShowServerCopy These are all stringified booleans with the value of the corresponding setting.
    • config.autoAdjustName
    • config.autoShowTerminal
    • config.suppressCompileMessages
    • config.suppressCompileErrorMessages
    • config.autoPreviewXML
    • config.showGeneratedFileDecorations
    • config.showProposedApiPrompt
  • commandExecuted Sent when almost any of our ~75 commands are executed
    • commandId
  • studioAddInOpened Sent when a user opens a Studio Add-In from the Server Actions menu.
    • addInName The name of the Add-In
  • workspaceFolder Sent for all workspace folders present at activation and any that are added later. All but scheme, config.syncLocalChanges, and serverVersion are stringified booleans.
    • scheme The scheme of the folder's Uri
    • serverVersion The semver-compatible version string of the server, if a connection is established ("2025.1.0"). Not the full $ZVERSION string.
    • added If the folder was added after activation
    • isWeb If this is a web application folder. Defined for server-side folders only.
    • isProject If this is a project folder. Defined for server-side folders only.
    • hasNs If this folder's Uri has a ns query parameter. Defined for server-side folders only.
    • config.syncLocalChanges The value of the objectscript.syncLocalChanges setting in this folder. Defined for client-side folders only.
    • dockerCompose If this folder uses docker compose for connection. Defined for client-side folders only.
  • unitTestRun Sent when a unit test run is started
    • scheme The scheme of the root unit test's Uri
    • debug If the run is a debug run (stringified boolean)
  • clientSideFileSynced Sent when a non-class or routine client-side file is about to be synced to the server 
    • fileExt The file's extension (lowercase)
  • lowCodeEditorOpened Sent when a low-code editor is opened.
    • scheme The scheme of the file's Uri
    • editorType "rule" or "dtl" for now.
  • debuggerStarted Sent when the debugger is started.
    • debugType "launch", "attach", "rest", or "unittest"
  • liteTerminalStarted Sent when the Lite Terminal is started.
    • terminalOrigin Where the terminal was opened from. "profile" or "command".
    • config.webSocketTerminal.syntaxColoring Stringified boolean containing the value of the objectscript.webSocketTerminal.syntaxColoring setting

@isc-bsaviano isc-bsaviano merged commit b9d1ebb into intersystems-community:master Jul 10, 2025
5 checks passed
@isc-bsaviano isc-bsaviano deleted the telemetry branch July 10, 2025 10:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants