Service Monitoring

VOR Stream provides multiple tools for monitoring the health and status of services in your deployment. This guide covers the various monitoring capabilities available to administrators.

Consul Dashboard

The VOR CLI includes a built-in Consul dashboard that provides real-time visibility into all services registered with Consul. This dashboard offers both interactive and static views of service health information.

Interactive Dashboard

The interactive dashboard provides a dynamic, real-time view of all Consul services with keyboard navigation and automatic updates.

To launch the interactive dashboard:

vor show connections --dashboard

Features:

• Real-time Updates: Automatically updates when service states change using Consul's blocking queries
• Service List View: Shows all services with their health status, instance count, and check results
• Service Details: Press Enter to view detailed health information for a specific service
• Keyboard Navigation:
  • ↑/↓ - Navigate through services
  • Enter - View service details
  • Escape - Return to service list
  • q - Quit the dashboard

The dashboard displays:

• Service name and overall health status
• Number of instances (nodes) running the service
• Count of passing, warning, and critical health checks
• Detailed node information including addresses and ports
• Individual health check results with output messages

Static Dashboard

For environments where interactive terminals are not available (e.g., CI/CD pipelines, automated reports), you can generate a static markdown view:

vor show connections --dashboard --static

This outputs a formatted markdown report showing:

• Service summary table with health statistics
• Detailed service information for each registered service
• Node addresses and health check results

Example output:

# Consul Services Dashboard

## Service Summary

| Service             | Status | Instances | Passing | Warning | Critical |
| ------------------- | ------ | --------- | ------- | ------- | -------- |
| compute             | ✅     | 1         | 1       | 0       | 0 |
| consul              | ✅     | 1         | 1       | 0       | 0 |
| django              | ✅     | 1         | 1       | 0       | 0 |
| postgres            | ✅     | 1         | 1       | 0       | 0 |
| rabbitmq            | ✅     | 1         | 1       | 0       | 0 |
| vault               | ✅     | 1         | 1       | 0       | 0 |

## Service Details

### compute (Healthy)
- **node1** - compute:23234 ✅ (TLS: disabled)
...

Connection Testing

The original functionality of testing connections to VOR Stream services remains available:

vor show connections

This command verifies:

• VOR Stream mid-tier connection and version
• Authorization to the mid-tier
• SDK API connection
• Django server health (database, file storage, migrations)

Supervisor Monitoring

In addition to the Consul dashboard, VOR Stream uses [Supervisor] (http://supervisord.org/) to manage service processes. See the Supervisor management guide for details on using supervisorctl to monitor and manage individual processes.

Best Practices

1. Regular Monitoring: Check the Consul dashboard regularly to ensure all services are healthy
2. Automated Alerts: Configure Consul watches or external monitoring tools to alert on service failures
3. Log Correlation: When a service shows as unhealthy, check its logs for detailed error information
4. Network Connectivity: Use vor show connections to verify network connectivity between components

Troubleshooting

If the Consul dashboard shows errors:

1. Verify Consul is Running: Ensure the Consul agent is running and accessible
2. Check Environment Variables: The dashboard respects CONSUL_HTTP_ADDR for non-standard Consul addresses
3. TLS Configuration: If using TLS, ensure proper certificates are configured
4. Service Registration: Verify services are properly registering with Consul on startup