spotlight/README.md at foremost · spotlight/spotlight · GitHub
Docs – Community (Support & Feedback) – Feature request – Bug report
spotlight.io is a monitoring device for the subsequent era of builders (such as you!). In contrast to the age-old, outdated instruments on the market, we purpose to construct a cohesive, modern and fully-featured monitoring resolution, one thing we wished WE had. And it is all open supply 🙂
At a excessive stage, spotlight.io’s function set is:
Learn extra about our features under.
We try to make spotlight.io as straightforward to put in as a number of strains of code in any surroundings.
Learn extra about our features, values and mission under, and get began at https://highlight.io at this time!
Desk of Contents
Get began
Hosted spotlight.io (free to get began!)
The quickest and most dependable approach to get began with spotlight.io is signing up without spending a dime at app.highlight.io. After making an account, getting began is as straightforward as putting in the client SDK snippet.
Interest self-hosted
Deploy a pastime occasion in a single line on Linux with Docker (advisable 16 CPU cores, 32GB RAM, 256GB disk):
git clone --recurse-submodules https://github.com/spotlight/spotlight
# or `git submodule replace --init --recursive` on git < 2.13
cd docker && ./run-hobby.sh
After a quick frontend load time, the app needs to be accessible at https://localhost:3000
Good for <10k classes and <50k errors ingested month-to-month. See our docs for more info and limitations.
Growing on Spotlight
Wish to contribute to Spotlight? See our onboarding information.
Enterprise self-hosted
See our enterprise self-hosted docs to deploy a scalable, production-ready occasion with help from our group.
Options
Session Replay: Perceive WHY bugs occur.
- Dom-based Excessive-fidelity Replay: Replay each interplay and dom change that occurred in a given browser session (powered by https://github.com/rrweb-io/rrweb)
- Outgoing Community Requests: See all of the community requests (and their contents) in a given session to breed the information that was despatched/obtained by your frontend -> docs
- Console logs: Analyze the logs printed (
console.error,console.log, and so forth..) to the console out of your frontend -> docs - Embedded Error Monitoring: See the errors related to a given session to know what the person was doing main as much as them.
- Session Feedback: Touch upon errors to speak along with your group on person frustration, bugs, and extra! -> docs
- Integrations along with your favourite instruments -> docs
Error Monitoring: Perceive WHAT bugs are taking place.
- Customizable Error Grouping: Customise guidelines for grouping repeated errors -> docs
- Customizable Alerting Guidelines: Customise how typically, and the place alerts are despatched -> docs
- Embedded Session Replay: See all the classes related to any given error.
- SDK Assist: Assist for an extended (and rising!) checklist of SDKs.
- Integrations along with your favourite instruments -> docs
Logging
- Highly effective Log Search: Search throughout all of your logs, with automated property assortment -> docs
- Log Alerts: Set thresholds to your log alerts, and consider them within the alerts dashboard -> docs
- Embedded Session Replay and Errors: See all the classes & errors related to any given log.
- SDK Assist: Assist for an extended (and rising!) checklist of SDKs.
- Integrations along with your favourite instruments -> docs
Extra?! Metrics? Traces? Merch?
Have an thought for what we must always construct subsequent? Please share our community or through a Github Challenge!
Read a full list of highlight.io features.
SDKs
All of our SDKs for spotlight.io might be discovered within the sdk directory. To get began with these SDKs, we suggest the getting started guide in our docs.
Our Mission
Our mission is to help builders such as you in transport with confidence. We do that by supplying you with the instruments you might want to uncover, resolve, and forestall points in your internet app.
Our Values
We construct in public.
We try to construct in public in each means we are able to. Which means what we constructed, what we’re constructing, and what we plan to construct is shared with the world.
We construct a cohesive product.
Individuals might imagine that we’re constructing a number of merchandise (session replay, error monitoring, and so forth..). However we see it as one. Earlier than we construct something new, we prioritize making it function seemlessly with every thing else.
We construct for at this time’s developer.
In case you’re constructing software program, why must you care about grafana or loki or the elk stack? spotlight.io is constructed for builders that need to develop. Depart the monitoring stuff to us
Learn extra about our values here.