Sprkl Sample Project
What is Sprkl?
Sprkl is a Personal Observability platform that provides personalized feedback on your code changes while coding in the IDE. Powered by OpenTelemetry, Sprkl instruments every code change and analyzes it upon execution. Sprkl helps ship correct and efficient code while spending less time on debugging, code reviews, and frustrating rework.
Getting Started
- Is this the first time you are using Sprkl? Start with our installation instructions at Sprkl Docs.
- Follow the sample project instructions in our docs.
- Make a code change.
- Instrument your code
Checkout our demo video for more guidance on how to get started.
Simple Example
To run a simple example:
yarn install
yarn example
This will:
- Make a code change (via git patch)
- Spin-up a docker-compose based micro-service application
- Perform Jest tests
Open the sprkl extension dashboard (click on the sloth icon on the left panel) to see the results in the Sprkl dashboard.
Additional Information
Documentation
Checkout our docs for additional instructions.
Help
Join our Slack community for the fastest answers to your questions! Or contact us at support@sprkl.dev.