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

perf(node): Truncate breadcrumb messages created by console integration #14006

Merged
merged 3 commits into from
Oct 18, 2024

Conversation

lforst
Copy link
Member

@lforst lforst commented Oct 17, 2024

We got a report that the SDK was consuming a lot of memory. Looking at the heap snapshot I noticed that we are unboundidly storing strings in breadcrumbs, no matter how large they are, leading to the breadcrumbs potentially holding a lot of memory.

Copy link
Contributor

github-actions bot commented Oct 17, 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 - -
@sentry/browser (incl. Tracing, Replay) - with treeshaking flags 62.26 KB - -
@sentry/browser (incl. Tracing, Replay with Canvas) 76.21 KB - -
@sentry/browser (incl. Tracing, Replay, Feedback) 89 KB - -
@sentry/browser (incl. Tracing, Replay, Feedback, metrics) 90.82 KB - -
@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 - -
CDN Bundle (incl. Tracing, Replay, Feedback) 76.99 KB - -
CDN Bundle - uncompressed 70.7 KB - -
CDN Bundle (incl. Tracing) - uncompressed 109.73 KB - -
CDN Bundle (incl. Tracing, Replay) - uncompressed 222.24 KB - -
CDN Bundle (incl. Tracing, Replay, Feedback) - uncompressed 235.46 KB - -
@sentry/nextjs (client) 38.06 KB - -
@sentry/sveltekit (client) 35.74 KB - -
@sentry/node 125.15 KB +0.01% +7 B 🔺
@sentry/node - without tracing 94.25 KB +0.01% +6 B 🔺
@sentry/aws-serverless 103.81 KB +0.01% +7 B 🔺

View base workflow run

@lforst lforst requested review from Lms24 and AbhiPrasad October 17, 2024 08:45
@@ -14,11 +17,17 @@ const _consoleIntegration = (() => {
return;
}

// Truncate the breadcrumb length to max 2KB including the truncated snippet
let formattedMessage: string = util.format.apply(undefined, args);
if (formattedMessage.length > MAX_BREADCRUMB_MSG_LENGTH) {
Copy link
Member

Choose a reason for hiding this comment

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

l: Why not just use truncate from @sentry/utils? :)

Copy link
Member Author

@lforst lforst Oct 18, 2024

Choose a reason for hiding this comment

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

I did not know that existed 🧠 nice

@lforst lforst requested a review from mydea October 18, 2024 07:55
Copy link
Member

@Lms24 Lms24 left a comment

Choose a reason for hiding this comment

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

Good change!

Copy link
Member

@Lms24 Lms24 left a comment

Choose a reason for hiding this comment

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

suggestion: Can we add a test for this?

wait, I'm realizing you said yesterday that we don't have any tests for this integration. Maybe it's worth to address this as a whole in a separate PR then.

@lforst
Copy link
Member Author

lforst commented Oct 18, 2024

I'm realizing you said yesterday that we don't have any tests for this integration. Maybe it's worth to address this as a whole in a separate PR then.

Fuck it, I'll be a good person for once and add tests 😂

@lforst lforst merged commit d3847b4 into develop Oct 18, 2024
146 of 148 checks passed
@lforst lforst deleted the lforst-truncate-console-breadcrumbs branch October 18, 2024 10:05
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
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants