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

feat(node): Add breadcrumbs for child_process and worker_thread #13896

Merged
merged 8 commits into from
Oct 29, 2024

Conversation

timfish
Copy link
Collaborator

@timfish timfish commented Oct 7, 2024

I saw these were available in diagnostics_channel so this PR adds a default integration that includes breadcrumbs for both child process and worker thread start, stop and error.

Copy link
Contributor

github-actions bot commented Oct 7, 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) 88.99 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.45 KB +0.24% +305 B 🔺
@sentry/node - without tracing 94.54 KB +0.3% +289 B 🔺
@sentry/aws-serverless 104.07 KB +0.25% +263 B 🔺

View base workflow run

@AbhiPrasad AbhiPrasad self-requested a review October 9, 2024 00:55
@timfish timfish self-assigned this Oct 17, 2024
@lforst lforst self-requested a review October 21, 2024 13:16
@lforst
Copy link
Member

lforst commented Oct 22, 2024

Sorry for letting this one slip a bit. I have a concern with the value behind the individual things we log. Right now it seems we do:

  • child/worker spawned
  • child/worker exited

If I put myself into the seat of a user that looks at an error in Sentry, I don't think I care to much when a worker/child is created. I mostly care about whether I receive some faulty messages from a worker (I don't think we can instrument this reliably), or whether a child/worker dies unexpectedly.

What do you think about limiting the created breadcrumbs to error exits of children only?

@timfish
Copy link
Collaborator Author

timfish commented Oct 22, 2024

I mostly care about whether I receive some faulty messages from a worker (I don't think we can instrument this reliably)

Both Worker and ChildProcess are EventEmitters, so we could use the 'newListener' event to wrap users 'message' handlers and add things like tracing or to add some more context if their handler functions throw.

What do you think about limiting the created breadcrumbs to error exits of children only?

Yep makes sense, I'll change this!

@lforst
Copy link
Member

lforst commented Oct 22, 2024

I mostly care about whether I receive some faulty messages from a worker (I don't think we can instrument this reliably)

Both Worker and ChildProcess are EventEmitters, so we could use the 'newListener' event to wrap users 'message' handlers and add things like tracing or to add some more context if their handler functions throw.

Ah that's good to know. I still have concerns with how spammy this potentially gets so let's keep this in our head in case we want to instrument it in the future. Or maybe we can make it optional 🤔

@timfish
Copy link
Collaborator Author

timfish commented Oct 22, 2024

Or maybe we can make it optional

We can also just add it later in another PR!

I guess we already do something similar in browserApiErrorsIntegration to wrap setTimeout, setInterval, etc? Why is that browser only and not needed in Node?

@lforst lforst merged commit d396241 into develop Oct 29, 2024
144 checks passed
@lforst lforst deleted the timfish/feat/process-worker-thread-breadcrumbs branch October 29, 2024 09:11
alexandresoro pushed a commit to alexandresoro/ouca that referenced this pull request Nov 3, 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.35.0` -> `8.36.0`](https://renovatebot.com/diffs/npm/@sentry%2fnode/8.35.0/8.36.0) |
| [@sentry/react](https://github.com/getsentry/sentry-javascript/tree/master/packages/react) ([source](https://github.com/getsentry/sentry-javascript)) | dependencies | minor | [`8.35.0` -> `8.36.0`](https://renovatebot.com/diffs/npm/@sentry%2freact/8.35.0/8.36.0) |

---

### Release Notes

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

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

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

##### Important Changes

-   **feat(nextjs/vercel-edge/cloudflare): Switch to OTEL for performance monitoring ([#&#8203;13889](getsentry/sentry-javascript#13889

With this release, the Sentry Next.js, and Cloudflare SDKs will now capture performance data based on OpenTelemetry.
Some exceptions apply in cases where Next.js captures inaccurate data itself.

NOTE: You may experience minor differences in transaction names in Sentry.
Most importantly transactions for serverside pages router invocations will now be named `GET /[param]/my/route` instead of `/[param]/my/route`.
This means that those transactions are now better aligned with the OpenTelemetry semantic conventions.

##### Other Changes

-   deps: Bump bundler plugins and CLI to 2.22.6 and 2.37.0 respectively ([#&#8203;14050](getsentry/sentry-javascript#14050))
-   feat(deps): bump [@&#8203;opentelemetry/instrumentation-aws-sdk](https://github.com/opentelemetry/instrumentation-aws-sdk) from 0.44.0 to 0.45.0 ([#&#8203;14099](getsentry/sentry-javascript#14099))
-   feat(deps): bump [@&#8203;opentelemetry/instrumentation-connect](https://github.com/opentelemetry/instrumentation-connect) from 0.39.0 to 0.40.0 ([#&#8203;14101](getsentry/sentry-javascript#14101))
-   feat(deps): bump [@&#8203;opentelemetry/instrumentation-express](https://github.com/opentelemetry/instrumentation-express) from 0.43.0 to 0.44.0 ([#&#8203;14102](getsentry/sentry-javascript#14102))
-   feat(deps): bump [@&#8203;opentelemetry/instrumentation-fs](https://github.com/opentelemetry/instrumentation-fs) from 0.15.0 to 0.16.0 ([#&#8203;14098](getsentry/sentry-javascript#14098))
-   feat(deps): bump [@&#8203;opentelemetry/instrumentation-kafkajs](https://github.com/opentelemetry/instrumentation-kafkajs) from 0.3.0 to 0.4.0 ([#&#8203;14100](getsentry/sentry-javascript#14100))
-   feat(nextjs): Add method and url to route handler request data ([#&#8203;14084](getsentry/sentry-javascript#14084))
-   feat(node): Add breadcrumbs for `child_process` and `worker_thread` ([#&#8203;13896](getsentry/sentry-javascript#13896))
-   fix(core): Ensure standalone spans are not sent if SDK is disabled ([#&#8203;14088](getsentry/sentry-javascript#14088))
-   fix(nextjs): Await flush in api handlers ([#&#8203;14023](getsentry/sentry-javascript#14023))
-   fix(nextjs): Don't leak webpack types into exports ([#&#8203;14116](getsentry/sentry-javascript#14116))
-   fix(nextjs): Fix matching logic for file convention type for root level components ([#&#8203;14038](getsentry/sentry-javascript#14038))
-   fix(nextjs): Respect directives in value injection loader ([#&#8203;14083](getsentry/sentry-javascript#14083))
-   fix(nuxt): Only wrap `.mjs` entry files in rollup ([#&#8203;14060](getsentry/sentry-javascript#14060))
-   fix(nuxt): Re-export all exported bindings ([#&#8203;14086](getsentry/sentry-javascript#14086))
-   fix(nuxt): Server-side setup in readme ([#&#8203;14049](getsentry/sentry-javascript#14049))
-   fix(profiling-node): Always warn when running on incompatible major version of Node.js ([#&#8203;14043](getsentry/sentry-javascript#14043))
-   fix(replay): Fix `onError` callback ([#&#8203;14002](getsentry/sentry-javascript#14002))
-   perf(otel): Only calculate current timestamp once ([#&#8203;14094](getsentry/sentry-javascript#14094))
-   test(browser-integration): Add sentry DSN route handler by default ([#&#8203;14095](getsentry/sentry-javascript#14095))

</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:eyJjcmVhdGVkSW5WZXIiOiIzOC4xMzguNiIsInVwZGF0ZWRJblZlciI6IjM4LjEzOC42IiwidGFyZ2V0QnJhbmNoIjoibWFpbiIsImxhYmVscyI6WyJkZXBlbmRlbmNpZXMiXX0=-->

Reviewed-on: https://git.tristess.app/alexandresoro/ouca/pulls/289
Reviewed-by: Alexandre Soro <code@soro.dev>
Co-authored-by: renovate <renovate@git.tristess.app>
Co-committed-by: renovate <renovate@git.tristess.app>
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.

2 participants