Monitoring & Logs
Set up monitoring, error tracking, and logging for ReturnMate operations.
4 min read
Last updated 31 December 2024
Proper monitoring helps you catch issues early and maintain reliable operations. This guide covers monitoring options and recommendations for ReturnMate.
Built-In Monitoring
System Status
ReturnMate provides built-in status monitoring:
- Go to Settings → System → Status
- View current system health
- Check integration connections
- See recent errors
Health Indicators
| Indicator | Meaning |
|---|---|
| Green | All systems operational |
| Yellow | Degraded performance |
| Red | Service disruption |
Error Logging
Viewing Errors
Access error logs:
- Go to Settings → System → Error Log
- Filter by date, type, or severity
- Click entries for details
Error Information
Each error log includes:
- Timestamp
- Error type and message
- Affected operation
- Stack trace (technical)
- Resolution status
Recommended Monitoring Stack
Sentry (Error Tracking)
We recommend Sentry for error tracking:
- Real-time error alerts
- Stack traces and context
- Issue grouping and trends
- Integration with development tools
Note: ReturnMate uses Sentry internally for error tracking to ensure platform reliability.
Uptime Monitoring
Monitor your return portal availability:
- UptimeRobot (free tier available)
- Pingdom
- StatusCake
Configure checks for:
- Return portal URL
- API endpoints
- Webhook endpoints
Setting Up Alerts
Alert Types
Configure alerts for:
| Alert | Trigger | Priority |
|---|---|---|
| Portal Down | Return portal unreachable | High |
| Label Failures | Multiple label generation fails | High |
| Webhook Errors | Webhook delivery failures | Medium |
| Sync Issues | Integration sync problems | Medium |
| Capacity Warnings | Approaching limits | Low |
Notification Channels
Receive alerts via:
- Slack
- SMS (for critical issues)
- PagerDuty
Performance Monitoring
Key Metrics
Monitor these performance indicators:
| Metric | Target | Alert Threshold |
|---|---|---|
| Page Load Time | < 3s | > 5s |
| API Response | < 500ms | > 2s |
| Label Generation | < 10s | > 30s |
| Database Queries | < 100ms | > 500ms |
Tools
Performance monitoring tools:
- Google Analytics (for portal)
- New Relic APM
- Datadog
Webhook Monitoring
Delivery Monitoring
Track webhook reliability:
- Success rate
- Average response time
- Failure patterns
Setting Up Monitoring
- Log all webhook deliveries
- Track success/failure rates
- Alert on high failure rates
- Review patterns weekly
Webhook Reliability
Aim for 99% webhook delivery success. Investigate if you drop below 95%.
Integration Health
Checking Integration Status
- Go to Settings → Integrations
- View status for each integration
- Green = healthy, Red = issue
Common Integration Issues
| Integration | Common Issues |
|---|---|
| Shopify | API rate limits, auth expiry |
| Gorgias | Sync delays, permission changes |
| Carriers | Credential expiry, service issues |
Log Retention
How Long Logs Are Kept
| Log Type | Retention |
|---|---|
| Error Logs | 90 days |
| Access Logs | 30 days |
| Webhook Logs | 30 days |
| Audit Logs | 2 years |
Exporting Logs
For longer retention:
- Set up scheduled exports
- Export to your logging system
- Archive for compliance
Best Practices
- Set up uptime monitoring for return portal
- Configure alerts for critical issues
- Review error logs weekly
- Monitor webhook delivery rates
- Track integration health daily
- Maintain log exports for compliance
Related Articles
Was this helpful?
Contact Support