Spotlight Sidecar support in Sentry-Ruby

[natikgadzhi]

Summary

This PR adds Spotlight / Sidecar support to Sentry-Ruby!

• PHP example: Add support for Spotlight sentry-php#1647 (thank you @cleptric!)
• JS Browser SDK: feat(node): Add Spotlight option to Node SDK sentry-javascript#9629 by @Lms24

This is still work in progress ;) /cc @sl0thentr0py, @cleptric, feedback very welcome!

Changes

• Added a separate Spotlight::Configuration object that has enabled and sidecar_url fields with defaults.
• Added a separate Spotlight::Transport that is similar to HTTPTransport, but YOLO-grade. Doesn't care about rate limits.
• Added a hook into http_transport.rb (not proud of that one) that calls Spotlight::Transport.new().send_data(data) when it has stuff to send, but before validating rate limits. Aligned with PHP version.

TODO

• Changelog + Documentation in Sentry-Ruby
• Follow-up with docs on Spotlight repo
• See if we need to disable GZIP for now, or add GZIP support to Sidecar Sidecar doesn't accept gzipped Envelopes/Requests? spotlight#102

Reviewing

• I verified that it sends data to local Sidecar proxy
• Proxy says it receives events
• But, my client-side app struggles to connect to proxy — so I don't see the traces in the UI yet. Expect some messiness there. PHP (and other?) stack traces are the wrong way around spotlight#116

[codecov]

Codecov Report

Merging #2175 (5e8462d) into master (9a22f26) will increase coverage by 0.00%.
The diff coverage is 100.00%.

Additional details and impacted files

@@           Coverage Diff           @@
##           master    #2175   +/-   ##
=======================================
  Coverage   97.34%   97.34%           
=======================================
  Files          99      100    +1     
  Lines        3692     3731   +39     
=======================================
+ Hits         3594     3632   +38     
- Misses         98       99    +1     

Components	Coverage Δ
sentry-ruby	98.02% <100.00%> (-0.01%)	⬇️
sentry-rails	94.98% <ø> (ø)
sentry-sidekiq	94.53% <ø> (ø)
sentry-resque	93.65% <ø> (ø)
sentry-delayed_job	94.44% <ø> (ø)
sentry-opentelemetry	100.00% <ø> (ø)

Files	Coverage Δ
sentry-ruby/lib/sentry/client.rb	100.00% <100.00%> (ø)
sentry-ruby/lib/sentry/configuration.rb	98.74% <100.00%> (+0.01%)	⬆️
sentry-ruby/lib/sentry/transport.rb	99.01% <100.00%> (-0.04%)	⬇️
sentry-ruby/lib/sentry/transport/http_transport.rb	100.00% <100.00%> (ø)
...y-ruby/lib/sentry/transport/spotlight_transport.rb	100.00% <100.00%> (ø)

... and 1 file with indirect coverage changes

[HazAT]

@natikgadzhi Added support to the sidecar to accept gzip/deflate encoding

[HazAT]

Generally LGTM - since this is a dev only feature and opt-in, I think we are fine with the tests we have but @sl0thentr0py should make sure this is how we want it to be
I already documented it here
https://spotlightjs.com/setup/sentry/

[natikgadzhi]

Yeah, this is very broken, I’ll work it today ;-)

[natikgadzhi]

Okay, update time!

• I removed the separate Spotlight::Configuration in favor of the simple Sentry-config-level setting.
• I verified that the thing actually works.

As long as @sl0thentr0py is happy, we can merge this as is, so folks can start using it. My approach would be to merge and follow-up with next steps, but while I have time, I'll add things in this PR:

• Improve Spotlight transport layer — try to re-use HTTPTransport as much as possible, perhaps inherit from it and override the methods that we won't use explicitly.
• Add tests for Spotlight itself to verify it picks up config URL correctly.
• Add back gzip encoding (perhaps easiest to inherit from http_transport).

/cc @HazAT

[natikgadzhi]

@HazAT, thank you for the Spotlight docs!

[sl0thentr0py]

taking this over to finish up

[sl0thentr0py]

tested new changes without DSN

[sl0thentr0py]

ok i made some changes and added specs
@natikgadzhi @HazAT if you wanna take a quick look, otherwise i'll merge and release tomorrow

[natikgadzhi]

I’ll look later today, but you should merge it, don’t block on me. Huge thank you for picking this up ❤️‍🩹

[sl0thentr0py]

discussed with @HazAT - i will add a max 3 retry on the spotlight transport so we don't spam logs in production tomorrow

[natikgadzhi]

I saw that in JS SDK, sounds good to be consistent. Want me to add some docs to the readme here, and to sentry-docs?

[sl0thentr0py]

i'm not sure if spotlight docs will be in sentry or separate, leaving that to @HazAT

[Lms24]

Spotlight docs live here: https://github.com/getsentry/spotlight/tree/main/packages/website (and end up here: https://spotlightjs.com/about/)