Anyone managed to get @sentry/profiling-node working on electron?

[redian]

Hello Sentry community.

We are working on an electron desktop app and we have recently configured Sentry on the project.
Error reporting, Tracing and Metrics(now deprecated) are working fine.

We are now looking into getting a bit more insights on the runtime performance of the app and were thinking of profiling the app on runtime using @sentry/profiling-node package. This is not yet supported on Electron apps only node and other JS apps.

Interested to know if anyone in the community has managed to get @sentry/profiling-node working on Electron?
Thank you in advance!

[lforst]

I think node profiling in electron should be possible. What exactly is missing?

[redian]

I added the details of the build and the copy of the error i am getting here #13978 (reply in thread)

This is the error i am seeing:

Sentry Logger [log]: [Tracing] Starting sampled root span
  op: startup
  name: App Startup
  ID: 7a1e33a38d863249
dyld[95543]: missing symbol called
{APP_PATH}/node_modules/electron/dist/Electron.app/Contents/MacOS/Electron exited with signal SIGKILL
error Command failed with exit code 1.
info Visit https://yarnpkg.com/en/docs/cli/run for documentation about this command.

[JonasBa]

I see. I would want to validate that the runtime is actually importing the correct binary here so I would ask you to try and remove the profiling integration and import the generated binary directly. It should be available inside node_modules/@sentry/profiling-node directory. Likely in the node-gyp build directory.

If you import that library directly, it should log the methods exposed by the binaries. Can you confirm that that works and you can see the methods?

[JonasBa]

@redian Just wanted to share an update as I've had some time to quickly look at this. It seems that the sigabrt here is related to the StartProfiling call. I'm unsure where exactly this comes from, but whenever we use the v8::CpuProfilingOptions options signature, we get a sigabrt.

I'll need to investigate this further to find a root cause and a workaround. The good news is that using a different signature works, however it doesn't allow us to set some options that we need.

[redian]

Thanks a lot @JonasBa for looking into this. Appreciate it 🙌

[JonasBa]

@redian Thanks for your patience, I have just merged a fix for the issue you reported. Once the change is released (hopefully by sometime mid next week), I would ask you to try it out, and see if you still have any issues (happy to help guide or answer any questions).

If you do decide to try it out, you will need to install the @electron/rebuild package which handles rebuilding packages with native binaries for electron and run it after installing @sentry/profiling-node (or manage the compilation yourself),

We currently don't provide any prebuilt binaries yet, but is something we'd be happy to reevaluate.