SVC-{{title}}
Descripción General
Breve descripción del servicio, su propósito principal y su rol dentro de la plataforma ZeroQ.
Propósito
¿Por qué existe este servicio? ¿Qué problema de negocio resuelve?
- Problema que resuelve:
- Usuarios/consumidores principales:
- Alternativa si no existiera:
Resumen de Arquitectura
[Diagrama simplificado del servicio y sus conexiones]
┌─────────────┐ ┌──────────────┐ ┌─────────────┐
│ Clientes │────▶│ Este SVC │────▶│ Database │
└─────────────┘ └──────────────┘ └─────────────┘
│
▼
┌──────────────┐
│ Queue/Cache │
└──────────────┘
- Tipo: service
- Lenguaje/Framework:
- Runtime:
- Destino de despliegue: kubernetes | docker | lambda
- Puerto:
- Protocolo: REST / gRPC / WebSocket
- Réplicas en prod: ❓ Pendiente de verificar
Dependencias
Upstream (servicios que llaman a este)
| Servicio | Método | Endpoint |
|---|---|---|
Downstream (servicios que este llama)
| Servicio | Método | Propósito |
|---|---|---|
Infraestructura
| Componente | Uso | Crítico |
|---|---|---|
| Sí/No |
Flujo de Datos
Descripción del flujo de datos principal:
Datos sensibles manejados
| Dato | Clasificación | Encriptado | Retención |
|---|---|---|---|
| PII / Interno / Público | Sí/No |
Modos de Falla
| Escenario | Impacto | Mitigación | Severidad |
|---|---|---|---|
| DB no disponible | |||
| Cache caído | |||
| Cola saturada | |||
| Timeout upstream |
Política de Reintentos / Circuit Breaker
- Intentos de reintento:
- Estrategia de backoff:
- Umbral de circuit breaker:
- Comportamiento de fallback:
Monitoreo
Health Check
- Endpoint:
/health - Intervalo: ❓ Pendiente de verificar
- Timeout: ❓ Pendiente de verificar
Métricas clave
| Métrica | Umbral de alerta | Dashboard |
|---|---|---|
| Latencia de request p99 | ||
| Tasa de errores | ||
| Uso de CPU | ||
| Uso de memoria |
Logs
- Formato: JSON estructurado
- Nivel por defecto: info
- Destino:
- Retención: ❓ Pendiente de verificar
Consideraciones de Seguridad
- Autenticación requerida (JWT / API Key / mTLS)
- Autorización por roles (RBAC)
- Rate limiting configurado
- Validación de entrada implementada
- Datos sensibles encriptados en reposo
- Datos sensibles encriptados en tránsito (TLS)
- Logging de auditoría habilitado
- No expone datos internos en errores
Entidades Principales
Si el servicio sigue DDD u otro patrón de organización, documentar las entidades principales.
| Entidad | Descripción |
|---|---|
Variables de Entorno Requeridas
| Variable | Descripción | Requerida |
|---|---|---|
| Sí/No |
Estrategia de Escalamiento
- Tipo: Horizontal / Vertical
- Auto-scaling: ❓ Pendiente de verificar
- Réplicas mínimas: ❓ Pendiente de verificar
- Réplicas máximas: ❓ Pendiente de verificar
- Trigger de escalamiento: CPU > X% / Request count > Y
- Limitaciones conocidas:
Consideraciones de DRP
- RTO: ❓ (Objetivo de Tiempo de Recuperación)
- RPO: ❓ (Objetivo de Punto de Recuperación)
- Estrategia de respaldo: ❓ Pendiente de verificar
- Failover automático: ❓ Pendiente de verificar
- Runbook:
[[PROC-DRP-{{title}}]]
Servicios Relacionados
Dataview LIST
LIST
FROM "01-Architecture/Services"
WHERE contains(related_services, this.file.link)
Esta query se ejecuta dinámicamente en Obsidian.
Preguntas Abiertas
- ❓
- ❓
- ❓