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

fix(replay): Ignore older performance entries when starting manually #13969

Merged
merged 2 commits into from
Oct 17, 2024

Conversation

mydea
Copy link
Member

@mydea mydea commented Oct 14, 2024

For replay, performance entries are captured separately, and added to the replay before we send it.
Generally, this works just fine, because when we buffer, we clear the captured performance events whenever the buffer is cleared.

However, when we manually start the replay, it can happen that we capture performane entries from way before we started the replay manually, which will in turn extend the timeline of the replay potentially drastically.

To fix this, we now drop any performance events, when starting manually, that happened more than a second before we manually started the replay.

The 1s is an arbitrary number to accomodate the fact that some entries can be emitted slightly before - when we immediately run replay.start() we generally want to try to keep those too.

@mydea mydea requested review from billyvg and chargome October 14, 2024 08:03
@mydea mydea self-assigned this Oct 14, 2024
@mydea mydea requested a review from a team as a code owner October 14, 2024 08:03
@mydea mydea added the Package: replay Issues related to the Sentry Replay SDK label Oct 14, 2024
Copy link
Contributor

github-actions bot commented Oct 14, 2024

size-limit report 📦

Path Size % Change Change
@sentry/browser 22.73 KB - -
@sentry/browser - with treeshaking flags 21.53 KB - -
@sentry/browser (incl. Tracing) 35.12 KB - -
@sentry/browser (incl. Tracing, Replay) 71.86 KB +0.04% +26 B 🔺
@sentry/browser (incl. Tracing, Replay) - with treeshaking flags 62.26 KB +0.04% +25 B 🔺
@sentry/browser (incl. Tracing, Replay with Canvas) 76.21 KB +0.03% +20 B 🔺
@sentry/browser (incl. Tracing, Replay, Feedback) 89 KB +0.03% +26 B 🔺
@sentry/browser (incl. Tracing, Replay, Feedback, metrics) 90.82 KB +0.03% +26 B 🔺
@sentry/browser (incl. metrics) 27 KB - -
@sentry/browser (incl. Feedback) 39.87 KB - -
@sentry/browser (incl. sendFeedback) 27.38 KB - -
@sentry/browser (incl. FeedbackAsync) 32.17 KB - -
@sentry/react 25.49 KB - -
@sentry/react (incl. Tracing) 38.09 KB - -
@sentry/vue 26.91 KB - -
@sentry/vue (incl. Tracing) 37.02 KB - -
@sentry/svelte 22.87 KB - -
CDN Bundle 24.11 KB - -
CDN Bundle (incl. Tracing) 36.96 KB - -
CDN Bundle (incl. Tracing, Replay) 71.65 KB +0.04% +25 B 🔺
CDN Bundle (incl. Tracing, Replay, Feedback) 76.99 KB +0.04% +28 B 🔺
CDN Bundle - uncompressed 70.7 KB - -
CDN Bundle (incl. Tracing) - uncompressed 109.73 KB - -
CDN Bundle (incl. Tracing, Replay) - uncompressed 222.24 KB +0.04% +75 B 🔺
CDN Bundle (incl. Tracing, Replay, Feedback) - uncompressed 235.46 KB +0.04% +75 B 🔺
@sentry/nextjs (client) 38.06 KB - -
@sentry/sveltekit (client) 35.74 KB - -
@sentry/node 125.15 KB - -
@sentry/node - without tracing 94.25 KB - -
@sentry/aws-serverless 103.81 KB - -

View base workflow run

Copy link
Member

@chargome chargome left a comment

Choose a reason for hiding this comment

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

Thanks for adding this!

Comment on lines 1061 to 1062
// We leave 1s wiggle room to accomodate timing differences for "immedidate" manual starts
const initialTimestampInSeconds = this._context.initialTimestamp / 1000 - 1;
Copy link
Member

Choose a reason for hiding this comment

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

Do we want the wiggle room? Since it's manual start, I think it's ok to only capture events after start. It's easier to explain to users as well.

Copy link
Member Author

Choose a reason for hiding this comment

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

the problem is that if you have code like this, I guess:

Sentry.init({
  replaysErrorSampleRate: 0,
  replaysSessionSampleRate: 0, 
  integrations: [replay]
});

if (isImportantUser) {
  replay.start();
}

Like this kind of pattern, where users start manually but "immediately", we would otherwise probably miss many of the page load performance entries, as they are often correctly pre-dated to Date.now() 🤔 but no strong feelings, it is a bit "random". happy to generally remove the wiggle room!

Copy link
Member

Choose a reason for hiding this comment

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

Ah didn't consider that... I think we keep it simple and remove the wiggle room, but don't feel strongly about this.

@mydea mydea force-pushed the fn/replay-performance-buffer branch from 5ee3f10 to e861f46 Compare October 17, 2024 18:32
@mydea
Copy link
Member Author

mydea commented Oct 17, 2024

I removed the wiggle room, I left in the test that shows the current behavior for immediate start as well :)

@mydea mydea merged commit 77b3355 into develop Oct 17, 2024
143 of 144 checks passed
@mydea mydea deleted the fn/replay-performance-buffer branch October 17, 2024 19:40
alexandresoro pushed a commit to alexandresoro/ouca that referenced this pull request Oct 21, 2024
This PR contains the following updates:

| Package | Type | Update | Change |
|---|---|---|---|
| [@sentry/node](https://github.com/getsentry/sentry-javascript/tree/master/packages/node) ([source](https://github.com/getsentry/sentry-javascript)) | dependencies | minor | [`8.34.0` -> `8.35.0`](https://renovatebot.com/diffs/npm/@sentry%2fnode/8.34.0/8.35.0) |
| [@sentry/react](https://github.com/getsentry/sentry-javascript/tree/master/packages/react) ([source](https://github.com/getsentry/sentry-javascript)) | dependencies | minor | [`8.34.0` -> `8.35.0`](https://renovatebot.com/diffs/npm/@sentry%2freact/8.34.0/8.35.0) |

---

### Release Notes

<details>
<summary>getsentry/sentry-javascript (@&#8203;sentry/node)</summary>

### [`v8.35.0`](https://github.com/getsentry/sentry-javascript/blob/HEAD/CHANGELOG.md#8350)

[Compare Source](getsentry/sentry-javascript@8.34.0...8.35.0)

##### Beta release of the official Nuxt Sentry SDK

This release marks the beta release of the `@sentry/nuxt` Sentry SDK. For details on how to use it, check out the
[Sentry Nuxt SDK README](https://github.com/getsentry/sentry-javascript/tree/develop/packages/nuxt). Please reach out on
[GitHub](https://github.com/getsentry/sentry-javascript/issues/new/choose) if you have any feedback or concerns.

-   **feat(nuxt): Make dynamic import() wrapping default
    ([#&#8203;13958](getsentry/sentry-javascript#13958 (BREAKING)
-   **feat(nuxt): Add Rollup plugin to wrap server entry with `import()`
    ([#&#8203;13945](getsentry/sentry-javascript#13945

**It is no longer required to add a Node `--import` flag. Please update your start command to avoid initializing Sentry
twice (BREAKING CHANGE).** The SDK will now apply modifications during the build of your application to allow for
patching of libraries during runtime. If run into issues with this change, you can disable this behavior in your
`nuxt.config.ts` and use the `--import` flag instead:

```js
sentry: {
  dynamicImportForServerEntry: false;
}
```

-   **feat(nuxt): Respect user-provided source map generation settings
    ([#&#8203;14020](getsentry/sentry-javascript#14020

We now require you to explicitly enable sourcemaps for the clientside so that Sentry can un-minify your errors. We made
this change so source maps aren't accidentally leaked to the public. Enable source maps on the client as follows:

```js
export default defineNuxtConfig({
  sourcemap: {
    client: true,
  },
});
```

-   feat(nuxt): Log server instrumentation might not work in dev
    ([#&#8203;14021](getsentry/sentry-javascript#14021))
-   feat(nuxt): Add Http `responseHook` with `waitUntil`
    ([#&#8203;13986](getsentry/sentry-javascript#13986))

##### Important Changes

-   **feat(vue): Add Pinia plugin ([#&#8203;13841](getsentry/sentry-javascript#13841

Support for [Pinia](https://pinia.vuejs.org/) is added in this release for `@sentry/vue`. To capture Pinia state data,
add `createSentryPiniaPlugin()` to your Pinia store:

```javascript
import { createPinia } from 'pinia';
import { createSentryPiniaPlugin } from '@&#8203;sentry/vue';

const pinia = createPinia();

pinia.use(createSentryPiniaPlugin());
```

-   **feat(node): Implement Sentry-specific http instrumentation
    ([#&#8203;13763](getsentry/sentry-javascript#13763

This change introduces a new `SentryHttpInstrumentation` to handle non-span related HTTP instrumentation, allowing it to
run side-by-side with OTel's `HttpInstrumentation`. This improves support for custom OTel setups and avoids conflicts
with Sentry's instrumentation. Additionally, the `spans: false` option is reintroduced for `httpIntegration` to disable
span emission while still allowing custom `HttpInstrumentation` instances (`httpIntegration({ spans: false })`).

-   **feat(core): Make stream instrumentation opt-in
    ([#&#8203;13951](getsentry/sentry-javascript#13951

This change adds a new option `trackFetchStreamPerformance` to the browser tracing integration. Only when set to `true`,
Sentry will instrument streams via fetch.

##### Other Changes

-   feat(node): Expose `suppressTracing` API ([#&#8203;13875](getsentry/sentry-javascript#13875))
-   feat(replay): Do not log "timeout while trying to read resp body" as exception
    ([#&#8203;13965](getsentry/sentry-javascript#13965))
-   chore(node): Bump `@opentelemetry/instrumentation-express` to `0.43.0`
    ([#&#8203;13948](getsentry/sentry-javascript#13948))
-   chore(node): Bump `@opentelemetry/instrumentation-fastify` to `0.40.0`
    ([#&#8203;13983](getsentry/sentry-javascript#13983))
-   fix: Ensure type for `init` is correct in meta frameworks
    ([#&#8203;13938](getsentry/sentry-javascript#13938))
-   fix(core): `.set` the `sentry-trace` header instead of `.append`ing in fetch instrumentation
    ([#&#8203;13907](getsentry/sentry-javascript#13907))
-   fix(module): keep version for node ESM package ([#&#8203;13922](getsentry/sentry-javascript#13922))
-   fix(node): Ensure `ignoreOutgoingRequests` of `httpIntegration` applies to breadcrumbs
    ([#&#8203;13970](getsentry/sentry-javascript#13970))
-   fix(replay): Fix onError sampling when loading an expired buffered session
    ([#&#8203;13962](getsentry/sentry-javascript#13962))
-   fix(replay): Ignore older performance entries when starting manually
    ([#&#8203;13969](getsentry/sentry-javascript#13969))
-   perf(node): Truncate breadcrumb messages created by console integration
    ([#&#8203;14006](getsentry/sentry-javascript#14006))

Work in this release was contributed by [@&#8203;ZakrepaShe](https://github.com/ZakrepaShe) and [@&#8203;zhiyan114](https://github.com/zhiyan114). Thank you for your contributions!

</details>

---

### Configuration

📅 **Schedule**: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined).

🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied.

♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox.

🔕 **Ignore**: Close this PR and you won't be reminded about these updates again.

---

 - [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check this box

---

This PR has been generated by [Renovate Bot](https://github.com/renovatebot/renovate).
<!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzOC4xMjguNiIsInVwZGF0ZWRJblZlciI6IjM4LjEyOC42IiwidGFyZ2V0QnJhbmNoIjoibWFpbiIsImxhYmVscyI6WyJkZXBlbmRlbmNpZXMiXX0=-->

Reviewed-on: https://git.tristess.app/alexandresoro/ouca/pulls/251
Reviewed-by: Alexandre Soro <[email protected]>
Co-authored-by: renovate <[email protected]>
Co-committed-by: renovate <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Package: replay Issues related to the Sentry Replay SDK
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants