[Profiling] Add Continuous Profiling mode

JonasBa commented 3 months ago

Problem Statement

We want to decouple profiles from the current transaction model and expose a way for users to profile code that is longer than 30s (current max profile duration )

Solution Brainstorm

Introduce a continuous profiling mode.

The continuous profiling mode is exclusive from the current profiling mode. We want to allow developers to start and stop the profiler as they please, yielding full control over what is profiled. The current API design docs are here and have not been finalized.

[x] Implement continuous profiling mode functionality without exposing it (https://github.com/getsentry/sentry-javascript/pull/12124)
[ ] Implement profile context on spans (tbd if via startSpan or some global context)
[ ] Standardize on the API and mode selection mechanism
[ ] Document and expose the API
- [x] Clarify self hosted support https://github.com/getsentry/sentry-javascript/pull/12124#discussion_r1625181977

An implementation details of the continuous profiling mode is that each span that is started during a profiling session has a profile context that includes the thread id, name and the profiler id that was currently active (we need this so we can stitch back the profile chunks back together.

Fwiw, the product is currently not handling this yet as we do not have a way to visualize continuous profiles yet. The plan is to implement the functionality and keep it hidden while we work on the in-product support for this.

kennethtruong commented 1 month ago

Before Continuous Profiling gets added, does Sentry allow programmatically creating a Profile? i.e if a User clicks on a button in our application would we be able to create a Profile that tracks what happens for the next 5 seconds?

JonasBa commented 1 month ago

@kennethtruong we do, but since profiles are currently tied to the transaction model, it means you need to start a span and then take care of stopping it at some point in time. You should be able to do this using inactive spans and then calling span.end() using a timeout.

kennethtruong commented 1 month ago

@kennethtruong we do, but since profiles are currently tied to the transaction model, it means you need to start a span and then take care of stopping it at some point in time. You should be able to do this using inactive spans and then calling span.end() using a timeout.

Ah nice let me try that out! Thank you

getsentry / sentry-javascript

[Profiling] Add Continuous Profiling mode #12330

Problem Statement

Solution Brainstorm