Introduction
Welcome to the Spectrix documentation. Learn how to quickly set up your monitoring infrastructure to track your applications and receive critical alerts anytime an issue arises.
How It Works
Spectrix operates heavily on a streamlined configuration structure for ease of use. Follow these core workflow steps to get everything running in minutes.
Add Your Service
Start by defining your target service in Spectrix. This acts as the root configuration for a specific application.
- Service Name: A unique recognizable identifier for your application.
- Base URL: The root URL where your service is hosted.
- Representation: Think of a service as your core backend, microservice, or main app instance.
Add API Endpoints
Once your service is created, attach specific endpoints that you want to monitor closely.
- Monitoring Routes: Define the exact paths (e.g.,
/api/v1/checkout) you want tracked. - Path-based Tracking: Gain granular insights into response times, error rates, and traffic per route.
Connect Alert Channels
Ensure you never miss a critical failure by integrating with your team`'`s communication tools.
- Integrations: Send automated alerts via Slack, Discord, or Custom Webhooks.
- Incident Notifications: Get instantly alerted when an endpoint acts up, breaches latency limits, or goes down.
Monitor and Respond
Use the Spectrix platform to keep a constant pulse on your entire infrastructure.
- Dashboard Monitoring: Visualize your health metrics and uptime in real-time.
- Logs & Streams: Inspect structured logs and live request streams for quick debugging.
- Realtime Alerts & Incidents: View, acknowledge, and resolve ongoing incidents quickly.
Need help or found a bug?
Spectrix is open source. Reach out to us by opening an issue on GitHub.