sentry-javascript icon indicating copy to clipboard operation
sentry-javascript copied to clipboard

Remove Ambiguous Vue component tracking options

Open Lms24 opened this issue 3 years ago • 0 comments

Problem Statement

In our Vue SDK, there are two ways how users can set the component tracking-relevant options:

Sentry.init({
  // dsn...
  trackComponents: true,
  timeout: 1000,
  hooks: ['init', 'mount', 'update']
})

Or

Sentry.init({
  // dsn...
  tracingOptions: {
    trackComponents: true,
    timeout: 1000,
    hooks: ['init', 'mount', 'update']
  }
})

Solution Brainstorm

We'd like to remove this ambiguity by

  • [ ] 1. [Pre-v8] deprecating one of the two options (i.e. all top 3 level or the tracingOptions options)
    • Our current vote goes to deprecating the top-level options in favour of the tracingOptions object to group component-tracking related options
    • However, the top level options are more prominent in our documentation and hence probably more used
  • [ ] 2. [v8] removing the deprecated options and update Sentry docs accordingly

Lms24 avatar Oct 07 '22 08:10 Lms24