Solidstart SDK for spotter.
npm install @spotter.dev/solidstartA full-stack observability framework with native SolidStart support, making API debugging simpler and more efficient.
Visit the GitHub repository HERE.
See the working demo CodesandBox. You will need to get an API key from Spotter.dev.
Demo source code can be found Github
Install the package for SolidStart:
``bash
npm install @spotter.dev/solidstart
pnpm install @spotter.dev/solidstart
`
To proceed, clone the repository:
`bash`
git clone https://github.com/emee-dev/spotter.git
Set up your .env.local file with the following variables:
`bash`
SPOTTER_API_KEY="spotter_xxxxxxxxxxxxx"
SPOTTER_PROJECT_ID="project_id"
Initialize the SDK in src/app.tsx:
`typescript
import { Spotter } from "@spotter/solidstart";
Spotter.init({
apikey: "your_api_key",
projectId: "your_project_id",
});
export default function App() {
return
}
`
To monitor requests, wrap route handlers in withSpotter:
`typescript
import type { APIEvent } from "@solidjs/start/server";
import { withSpotter } from "@spotter/solidstart";
export const GET = withSpotter(async (event) => {
return Response.json({ message: "Hello" });
});
`
- [x] Request observability
- [x] Schema inference
- [ ] Action observability
- [ ] Payload masking
- [ ] Security evaluations
- [ ] Webhook support
- [ ] Automatic OpenAPI generation
View all planned features and issues HERE.
Contributions are encouraged! Steps to contribute:
1. Fork the repository.
2. Create a new feature branch (git checkout -b feature/AmazingFeature).git commit -m 'Add AmazingFeature'
3. Commit changes ().git push origin feature/AmazingFeature
4. Push to the branch ().
5. Open a pull request.
Distributed under the MIT License. See LICENSE.txt` for details.
Emmanuel Ajike - @emee-dev - emmanuelajike2000@gmail.com
Special thanks to: