| # {{ service.name }} Operational Runbook | |
| **Generated:** {{ generated_timestamp }} | |
| **Service Category:** {{ category }} | |
| **SLO Tier:** {{ service.slo_tier }} | |
| ## Service Overview | |
| - **Name:** {{ service.name }} | |
| - **Type:** {{ service.type }} | |
| - **Runtime:** {{ service.runtime }} | |
| - **Dependencies:** {% if service.dependencies %}{{ service.dependencies|join(', ') }}{% else %}None{% endif %} | |
| ## SLO Requirements | |
| - **Availability:** {{ slo_spec.availability }}% | |
| - **Latency P99:** {{ slo_spec.latency_p99 }} | |
| - **Recovery Time:** {{ slo_spec.recovery_time }} | |
| - **Max Downtime:** {{ slo_spec.max_downtime }} | |
| ## Port Configuration | |
| {% if service.ports %} | |
| {% for port in service.ports %} | |
| - Port {{ port }}: {{ service.type }} service | |
| {% endfor %} | |
| {% else %} | |
| No external ports configured. | |
| {% endif %} | |
| ## Health Checks | |
| ### Manual Health Check | |
| ```bash | |
| # Check service status | |
| supervisorctl status {{ service.name }} | |
| # View recent logs | |
| tail -f /data/adaptai/platform/dataops/dto/logs/{{ service.name.replace('dto-', '') }}.log | |
| ``` | |
| ### Automated Monitoring | |
| - Health monitor endpoint: http://localhost:8090/health/{{ service.name }} | |
| - Metrics available in Prometheus format | |
| ## Troubleshooting | |
| ### Common Issues | |
| 1. **Service Won't Start** | |
| - Check dependencies are running | |
| - Verify configuration files exist | |
| - Check file permissions | |
| - Review supervisord logs | |
| 2. **Performance Issues** | |
| - Monitor CPU and memory usage | |
| - Check for resource limits | |
| - Review SLO compliance metrics | |
| 3. **Connection Issues** | |
| - Verify port availability | |
| - Check firewall rules | |
| - Test network connectivity | |
| ### Recovery Procedures | |
| 1. **Restart Service** | |
| ```bash | |
| supervisorctl restart {{ service.name }} | |
| ``` | |
| 2. **Full Recovery** | |
| ```bash | |
| supervisorctl stop {{ service.name }} | |
| # Investigate logs and fix issues | |
| supervisorctl start {{ service.name }} | |
| ``` | |
| 3. **Emergency Escalation** | |
| - Critical services require immediate attention | |
| - Contact: dto-team@adapt.ai | |
| - Slack: #dto-alerts | |
| ## Configuration Files | |
| {% if service.type == 'message-broker' %} | |
| - NATS config: `/data/adaptai/platform/dataops/dto/events/nats/config.yaml` | |
| {% elif service.type == 'cache-cluster' %} | |
| - Dragonfly config: `/data/adaptai/platform/dataops/dto/cache/dragonfly_config.yaml` | |
| {% elif service.type == 'graph-database' %} | |
| - JanusGraph config: `/data/adaptai/platform/dataops/dto/lineage/janusgraph_config.properties` | |
| {% endif %} | |
| ## Maintenance Windows | |
| - **Planned maintenance:** Coordinate with dto-team | |
| - **Emergency maintenance:** Follow incident response procedures | |
| - **SLO impact:** Document any SLO violations | |
| --- | |
| *This runbook is auto-generated from the DTO manifest. Do not edit manually.* |