https://github.com/getsentry/spotlight

Sentry for Development
https://github.com/getsentry/spotlight

debugging debugging-tool tag-production

Last synced: 10 days ago
JSON representation

Sentry for Development

• Host: GitHub
• URL: https://github.com/getsentry/spotlight
• Owner: getsentry
• License: other
• Created: 2023-08-21T19:23:52.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2026-03-16T09:28:01.000Z (11 days ago)
• Last Synced: 2026-03-16T20:16:24.993Z (11 days ago)
• Topics: debugging, debugging-tool, tag-production
• Language: TypeScript
• Homepage: https://spotlightjs.com
• Size: 15.2 MB
• Stars: 573
• Watchers: 34
• Forks: 32
• Open Issues: 45
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Agents: AGENTS.md

Awesome Lists containing this project

README

          


  

    

  





  For more information, see our documentation.



# What's Spotlight? [![npm version](https://img.shields.io/npm/v/@spotlightjs/spotlight.svg)](https://www.npmjs.com/package/@spotlightjs/spotlight)

Spotlight is Sentry for Development. Debuggability elevated. Spotlight brings rich observability into development environments by leveraging the power of Sentry's SDKs, giving you real-time insights into errors, performance, and logs—essential for modern development and AI-assisted coding workflows.

## What You Can Do

- View real-time errors, traces, logs, and performance data from your applications

- Monitor multiple projects simultaneously in one place

- Stream and tail events with various output formats (human, logfmt, json, markdown)

- Run commands with automatic Spotlight integration

- Integrate with AI coding assistants via MCP server, giving AI tools direct access to your application's telemetry for smarter debugging and development

## How to Use Spotlight

Spotlight offers two main ways to work with your development telemetry:

**Electron App (macOS)**: Download the standalone desktop application for a native experience.

**CLI** (`npx @spotlightjs/spotlight`): Run the command-line tool with multiple modes:

- Default mode starts a web UI server for viewing telemetry in your browser

- `spotlight tail [types...]` - stream events (errors, traces, logs, attachments) to your terminal with multiple formatters

- `spotlight run ` - run your application with Spotlight automatically configured

- `spotlight mcp` - start the MCP server for AI tool integration (stdio + HTTP)

## How It Works

Spotlight uses Sentry SDKs to capture telemetry data and sends it to the Sidecar, a local proxy server running on your machine. The Sidecar processes these events and forwards them to the UI, where you can view everything in real-time via the web interface or stream output to your terminal. Spotlight works standalone or alongside your existing Sentry setup without interference.

## Links

- [![Documentation](https://img.shields.io/badge/documentation-spotlight-indigo.svg)](https://spotlightjs.com/about/)

- [![Discord](https://img.shields.io/discord/621778831602221064)](https://discord.gg/EJjqM3XtXQ)

- [![Stack Overflow](https://img.shields.io/badge/stack%20overflow-sentry-green.svg)](http://stackoverflow.com/questions/tagged/sentry)

- [![Twitter Follow](https://img.shields.io/twitter/follow/getsentry?label=getsentry&style=social)](https://twitter.com/intent/follow?screen_name=getsentry)

## Resources

- [Contribute](https://spotlightjs.com/docs/contribute/)

- [Setup Spotlight](https://spotlightjs.com/docs/getting-started)

- [Configuration](https://spotlightjs.com/docs/reference/configuration/)

- [Sidecar](https://spotlightjs.com/docs/sidecar/)