Skip to content

feat: opt-in install scripts with anonymous usage telemetry - #30

Closed
Ritvik Jayaswal (Ritvik-Jayaswal) wants to merge 1 commit into
mainfrom
feat/optin-usage-telemetry-azure
Closed

Ritvik Jayaswal (Ritvik-Jayaswal) wants to merge 1 commit into
mainfrom
feat/optin-usage-telemetry-azure

Conversation

@Ritvik-Jayaswal

Copy link
Copy Markdown
Collaborator

What

Adds cross-platform install scripts that copy/symlink the skills/ folder into an agent's skills directory, with anonymous, opt-in usage telemetry so maintainers can see which skills are actually installed.

  • scripts/install.ps1 (Windows/PowerShell)
  • scripts/install.sh (macOS/Linux)
  • TELEMETRY.md documents exactly what is / isn't collected
  • README updated with install-script section + telemetry link

Telemetry

  • Off by default. Only sent with -Telemetry / --telemetry or DDBKIT_TELEMETRY=1.
  • One skill_install event to Application Insights: kit version, target, OS family, install method, list of skill names, skill count, random per-invocation id.
  • No file contents, credentials, or stable machine/user identifiers.
  • Telemetry failures never block an install.

Notes

  • The App Insights instrumentation key is ingestion-only and safe to embed in client-side installers.

@Ritvik-Jayaswal
Ritvik Jayaswal (Ritvik-Jayaswal) marked this pull request as draft July 6, 2026 17:35
@lionelc
Lei Jiang (lionelc) self-requested a review July 6, 2026 18:49

@lionelc Lei Jiang (lionelc) left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We need to discuss about the exposed key. In its current form, it can't be merged.

Comment thread scripts/install.ps1 Outdated
$KitVersion = '1.0.0'
# App Insights ingestion key. An instrumentation key is an ingestion-only
# identifier and is safe to embed in client-side installers.
$InstrumentationKey = '9c3ca0ad-9326-412b-a325-70acfe2e33e3'

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why expose this key to the public? What's the risk?

Add scripts/install.ps1 and scripts/install.sh that install skills and, only when explicitly opted in (-Telemetry/--telemetry or DDBKIT_TELEMETRY=1), send one anonymous skill_install event to Application Insights. Document collection in TELEMETRY.md and reference from README. Telemetry is off by default and never blocks installs.
@Ritvik-Jayaswal
Ritvik Jayaswal (Ritvik-Jayaswal) deleted the feat/optin-usage-telemetry-azure branch July 6, 2026 19:32
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