Skip to content
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

Telemetry: Add platform info to telemetry event #24081

Merged
merged 7 commits into from
Sep 7, 2023

Conversation

yannbf
Copy link
Member

@yannbf yannbf commented Sep 5, 2023

Closes #

What I did

This PR does a few things:

  • Adds platform info (windows/macos/linux) to the telemetry event
  • Adds browser info to manager and preview error events
  • Fix a bug in the error preprocessing in manager errors

Checklist for Contributors

Testing

The changes in this PR are covered in the following automated tests:

  • stories
  • unit tests
  • integration tests
  • end-to-end tests

Manual testing

This section is mandatory for all contributions. If you believe no manual test is necessary, please state so explicitly. Thanks!

  1. Run a sandbox for template, e.g. yarn task --task sandbox --start-from auto --template react-vite/default-ts
  2. Run Storybook with STORYBOOK_TELEMETRY_DEBUG=1
  3. Open Storybook in your browser
  4. execute window.sendTelemetryError(new Error('boom!'))
  5. Check telemetry logs in the CLI

Documentation

  • Add or update documentation reflecting your changes
  • If you are deprecating/removing a feature, make sure to update
    MIGRATION.MD

Checklist for Maintainers

  • When this PR is ready for testing, make sure to add ci:normal, ci:merged or ci:daily GH label to it to run a specific set of sandboxes. The particular set of sandboxes can be found in code/lib/cli/src/sandbox-templates.ts

  • Make sure this PR contains one of the labels below:

    Available labels
    • bug: Internal changes that fixes incorrect behavior.
    • maintenance: User-facing maintenance tasks.
    • dependencies: Upgrading (sometimes downgrading) dependencies.
    • build: Internal-facing build tooling & test updates. Will not show up in release changelog.
    • cleanup: Minor cleanup style change. Will not show up in release changelog.
    • documentation: Documentation only changes. Will not show up in release changelog.
    • feature request: Introducing a new feature.
    • BREAKING CHANGE: Changes that break compatibility in some way with current major version.
    • other: Changes that don't fit in the above categories.

🦋 Canary release

This PR does not have a canary release associated. You can request a canary release of this pull request by mentioning the @storybookjs/core team here.

core team members can create a canary release here or locally with gh workflow run --repo storybookjs/storybook canary-release-pr.yml --field pr=<PR_NUMBER>

@socket-security
Copy link

New dependencies detected. Learn more about Socket for GitHub ↗︎

Packages Version New capabilities Transitives Size Publisher
browser-dtector 3.4.0 None +0 108 kB sibiraj-s

@yannbf yannbf force-pushed the yann/improve-telemetry-metadata branch from 898314f to 363c268 Compare September 6, 2023 12:28
code/lib/core-server/src/withTelemetry.ts Outdated Show resolved Hide resolved
code/lib/preview/src/utils.ts Outdated Show resolved Hide resolved
@ndelangen
Copy link
Member

Thank you for making all the changes I requested @yannbf 👏

@yannbf yannbf merged commit d2fc6de into next Sep 7, 2023
52 of 53 checks passed
@yannbf yannbf deleted the yann/improve-telemetry-metadata branch September 7, 2023 08:23
@github-actions github-actions bot mentioned this pull request Sep 7, 2023
25 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants