search

getsentry / spotlight

Your Universal Debug Toolbar
https://spotlightjs.com
Other
377 stars 11 forks source link

What does this do? #561

Open boxed opened 4 days ago

boxed commented 4 days ago

The main page and the docs talks about what spotlight is inspired by, what the architecture is, that it's great, etc, but it doesn't explain at all what it does. A list of things it can help you with should be on the very first page.

BYK commented 4 days ago

Hi @boxed and thank you so much for opening this issue (and your interest in Spotlight)! We are well aware that the landing page and even some other pages on the website don't really convey what Spotlight is about.

These coming few weeks are going to be spent on these parts but we didn't have an issue documenting the work so I'll use the one you created here :)

BYK commented 4 days ago

And to answer your question briefly:

Spotlight is a fully local debugging tool that surfaces events from Sentry SDKs in your applications for errors with neat stack traces, performance characteristics, distributed (and non-distributed) tracing information along with DB queries.

boxed commented 3 days ago

That presumes someone already knows a ton.

BYK commented 3 days ago

@boxed if you can help me with the confusing parts or what you want to see briefly, I'll make sure to address those in the final copy. That should also help many others like yourself.

boxed commented 3 days ago

"See what and how many SQL calls you app makes" is easy to understand.

I don't understand what beat stack traces means, but I'm used to Django that has nice crash pages in dev already, so maybe that is more for some other framework?

Tracing is a bit vague.