Skip to content

Commit

Permalink
Fixes #71
Browse files Browse the repository at this point in the history
  • Loading branch information
HazAT committed Nov 23, 2023
1 parent 35c5614 commit 626af12
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 2 deletions.
Binary file added packages/website/public/images/architecture.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
14 changes: 12 additions & 2 deletions packages/website/src/content/docs/architecture.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,16 @@
title: Architecture of Spotlight
---

TODO
import Architecture from "../../../public/images/architecture.png";

Here will be a simple drawing of the different parts of Spotlight and how they interact.
<img src={Architecture.src} width="80%" alt="Spotlight Architecture" />

### Description

Spotlight consists of 2 main components. The UI that is embeded in your Website.
And a Sidecar (Proxy) that streams incoming events to the UI.

You can send any kind of events to the Sidecar, it forwards it to Spotlight and the integrations within Spotlight need to understand what to do with it.

Spotlight by default has a Sentry integration, if you are using a Sentry SDK and enable the Spotliht connection (only required on the Server), Spotlight is able
to render Traces/Errors and more in your frontend.

0 comments on commit 626af12

Please sign in to comment.