Merged in feature/update-docs (pull request #180)

Update complete pdf code for entire system

* docs

and code for generation of updated docs
This commit is contained in:
Jay Brown
2025-09-09 19:34:03 +00:00
parent 730f3ba11a
commit da6de0080b
15 changed files with 1096 additions and 19 deletions
+12
View File
@@ -1,5 +1,9 @@
# Operations Guide
## Updated Operations (September 2025)
This guide covers deployment, monitoring, and operational procedures for the enhanced platform including batch processing capabilities, comprehensive Prometheus metrics, and background task management.
## Deployment Procedures
### Local Development Deployment
@@ -84,6 +88,10 @@ kubectl rollout undo deployment/query-api
## Monitoring and Alerting
### Enhanced Prometheus Metrics (September 2025)
The platform now provides comprehensive observability with 12 standard metric types covering all aspects of system performance and health.
### Prometheus Metrics
#### System Metrics
@@ -92,6 +100,10 @@ All services automatically expose metrics at `/metrics`:
- **Database connections**: Pool usage, connection count, query duration
- **Queue processing**: Message count, processing time, errors
- **Business metrics**: Documents processed, queries executed, results generated
- **Batch processing**: ZIP upload metrics, batch completion rates, failed document tracking
- **Background tasks**: Task execution statistics, periodic job performance
- **Resource usage**: Memory, CPU, goroutine counts
- **Cache operations**: Hit/miss ratios, cache size, eviction rates
#### Custom Metrics Example
```go