@spotter.dev/solidstart NPM

Spotter

A full-stack observability framework with native SolidStart support, making API debugging simpler and more efficient.

Github Repository

Visit the GitHub repository HERE.

Demo

See the working demo CodesandBox. You will need to get an API key from Spotter.dev.

Demo source code can be found Github

Installation

Install the package for SolidStart:

npm install @spotter.dev/solidstart

# or

pnpm install @spotter.dev/solidstart

To proceed, clone the repository:

git clone https://github.com/emee-dev/spotter.git

Environment Variables

Set up your .env.local file with the following variables:

SPOTTER_API_KEY="spotter_xxxxxxxxxxxxx"
SPOTTER_PROJECT_ID="project_id"

Usage

Initialize the SDK in src/app.tsx:

import { Spotter } from "@spotter/solidstart";

Spotter.init({
  apikey: "your_api_key",
  projectId: "your_project_id",
});

export default function App() {
  return <Router>...</Router>;
}

To monitor requests, wrap route handlers in withSpotter:

import type { APIEvent } from "@solidjs/start/server";
import { withSpotter } from "@spotter/solidstart";

export const GET = withSpotter(async (event) => {
  return Response.json({ message: "Hello" });
});