Project-Based Filtering in Spotlight

[Shubhdeep12]

Today, we are solely filtering local events in Spotlight using context. This is causing issues for users because events created from the server side are not recognized as local events, as Spotlight is initiated on the client side.

Additionally, we should provide users with the flexibility to filter events based on different projects while using Spotlight simultaneously.

Approach:

• While sending event envelopes to the sidecar, we will include a header spotlight-project-id with a value set as a custom project_id by the user.
• The Sidecar will store the project_id along with the envelope.
• When the Spotlight overlay subscribes to the eventSource, an ID attached to every message event will correspond to the stored project_id.
• Envelopes received in Spotlight will always have a project_id attached to them.

Changes to be done:

• Spotlight Sidecar and Overlay

  • To accept the spotlight project_id while Spotlight.init
  • Provide filtering support.
  • Determine local events based on project_id.
  • Send data to the sidecar with project_id for browser-sent Sentry envelopes.

• Sentry SDKs

  • To add projectId in options for SpotlightIntegration.
  • Send the header for project_id to the sidecar while sending envelopes.

[Shubhdeep12]

a branch for the POC - https://github.com/getsentry/spotlight/tree/feat/spotlight-project-id

Just need to send project_id while spotlight init
Also if running SDK locally then send the same project ID as a header with the key - spotlight-project-id to sidecar stream.