Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

What does this do? #561

Open
boxed opened this issue Nov 19, 2024 · 5 comments
Open

What does this do? #561

boxed opened this issue Nov 19, 2024 · 5 comments
Assignees
Labels
Type: Documentation Improvements or additions to documentation

Comments

@boxed
Copy link

boxed commented Nov 19, 2024

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 BYK self-assigned this Nov 19, 2024
@BYK BYK added the Type: Documentation Improvements or additions to documentation label Nov 19, 2024
@BYK
Copy link
Member

BYK commented Nov 19, 2024

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
Copy link
Member

BYK commented Nov 19, 2024

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
Copy link
Author

boxed commented Nov 19, 2024

That presumes someone already knows a ton.

@BYK
Copy link
Member

BYK commented Nov 19, 2024

@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
Copy link
Author

boxed commented Nov 19, 2024

"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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Type: Documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants