docs: add mkdocs, update links, add architecture documentation

This commit is contained in:
2025-11-05 07:44:21 +01:00
parent 6a17236474
commit 54a047f5dc
351 changed files with 3482 additions and 10 deletions

View File

@@ -0,0 +1,48 @@
# Phase 6: Observability & Production Readiness
## Overview
Complete observability setup with OpenTelemetry, integrate error reporting with Sentry, enhance logging with correlation IDs, and add rate limiting.
## Tasks
### 6.1 OpenTelemetry Completion
- [6.1.1 - Complete OpenTelemetry Setup](./6.1.1-complete-opentelemetry-setup.md)
- [6.1.2 - Create Custom Spans](./6.1.2-create-custom-spans.md)
- [6.1.3 - Add Trace Context Propagation](./6.1.3-add-trace-context-propagation.md)
### 6.2 Error Reporting (Sentry)
- [6.2.1 - Install Sentry](./6.2.1-install-githubcomgetsentrysentry-go.md)
- [6.2.2 - Integrate with Error Bus](./6.2.2-integrate-with-error-bus.md)
- [6.2.3 - Add Sentry Middleware](./6.2.3-add-sentry-middleware.md)
- [6.2.4 - Configure Sentry DSN](./6.2.4-configure-sentry-dsn-via-config.md)
### 6.3 Enhanced Logging
- [6.3.1 - Add Request Correlation](./6.3.1-add-request-correlation.md)
- [6.3.2 - Add Structured Fields](./6.3.2-add-structured-fields.md)
- [6.3.3 - Create Log Aggregation Config](./6.3.3-create-log-aggregation-config.md)
### 6.4 Rate Limiting
- [6.4.1 - Create Rate Limiter Interface](./6.4.1-create-pkgratelimitratelimitergo-interface.md)
- [6.4.2 - Implement Redis Rate Limiter](./6.4.2-implement-internalratelimitredis_limitergo.md)
- [6.4.3 - Add Rate Limit Middleware](./6.4.3-add-rate-limit-middleware.md)
### 6.5 Production Configuration
- [6.5.1 - Create Production Config Template](./6.5.1-create-production-config-template.md)
- [6.5.2 - Add Environment-Specific Settings](./6.5.2-add-environment-specific-settings.md)
## Deliverables Checklist
- [ ] OpenTelemetry fully integrated with custom spans
- [ ] Sentry error reporting working
- [ ] Enhanced logging with correlation IDs
- [ ] Rate limiting middleware implemented
- [ ] Production configuration templates ready
- [ ] All observability data flowing to external systems
## Acceptance Criteria
- Traces are exported to OTLP endpoint
- Errors are reported to Sentry
- Logs include correlation IDs
- Rate limiting prevents abuse
- Production configs are validated
- All metrics are exposed via Prometheus