docs: add mkdocs, update links, add architecture documentation
This commit is contained in:
@@ -0,0 +1,40 @@
|
||||
# Task 6.1.1: Complete OpenTelemetry setup:
|
||||
|
||||
## Metadata
|
||||
- **Task ID**: 6.1.1
|
||||
- **Title**: Complete OpenTelemetry setup:
|
||||
- **Phase**: 6 - Observability & Production Readiness
|
||||
- **Section**: 6.1
|
||||
- **Status**: Pending
|
||||
- **Priority**: High
|
||||
- **Estimated Time**: TBD
|
||||
- **Dependencies**: TBD
|
||||
|
||||
## Description
|
||||
Complete OpenTelemetry setup:
|
||||
|
||||
## Requirements
|
||||
- Complete OpenTelemetry setup:
|
||||
|
||||
## Implementation Steps
|
||||
1. TODO: Add implementation steps
|
||||
2. TODO: Add implementation steps
|
||||
3. TODO: Add implementation steps
|
||||
|
||||
## Acceptance Criteria
|
||||
- [ ] Task 6.1.1 is completed
|
||||
- [ ] All requirements are met
|
||||
- [ ] Code compiles and tests pass
|
||||
|
||||
## Related ADRs
|
||||
- See relevant ADRs in `docs/adr/`
|
||||
|
||||
## Implementation Notes
|
||||
- TODO: Add implementation notes
|
||||
|
||||
## Testing
|
||||
```bash
|
||||
# TODO: Add test commands
|
||||
go test ./...
|
||||
```
|
||||
|
||||
40
docs/content/stories/phase6/6.1.2-create-custom-spans.md
Normal file
40
docs/content/stories/phase6/6.1.2-create-custom-spans.md
Normal file
@@ -0,0 +1,40 @@
|
||||
# Task 6.1.2: Create custom spans:
|
||||
|
||||
## Metadata
|
||||
- **Task ID**: 6.1.2
|
||||
- **Title**: Create custom spans:
|
||||
- **Phase**: 6 - Observability & Production Readiness
|
||||
- **Section**: 6.1
|
||||
- **Status**: Pending
|
||||
- **Priority**: High
|
||||
- **Estimated Time**: TBD
|
||||
- **Dependencies**: TBD
|
||||
|
||||
## Description
|
||||
Create custom spans:
|
||||
|
||||
## Requirements
|
||||
- Create custom spans:
|
||||
|
||||
## Implementation Steps
|
||||
1. TODO: Add implementation steps
|
||||
2. TODO: Add implementation steps
|
||||
3. TODO: Add implementation steps
|
||||
|
||||
## Acceptance Criteria
|
||||
- [ ] Task 6.1.2 is completed
|
||||
- [ ] All requirements are met
|
||||
- [ ] Code compiles and tests pass
|
||||
|
||||
## Related ADRs
|
||||
- See relevant ADRs in `docs/adr/`
|
||||
|
||||
## Implementation Notes
|
||||
- TODO: Add implementation notes
|
||||
|
||||
## Testing
|
||||
```bash
|
||||
# TODO: Add test commands
|
||||
go test ./...
|
||||
```
|
||||
|
||||
@@ -0,0 +1,40 @@
|
||||
# Task 6.1.3: Add trace context propagation:
|
||||
|
||||
## Metadata
|
||||
- **Task ID**: 6.1.3
|
||||
- **Title**: Add trace context propagation:
|
||||
- **Phase**: 6 - Observability & Production Readiness
|
||||
- **Section**: 6.1
|
||||
- **Status**: Pending
|
||||
- **Priority**: High
|
||||
- **Estimated Time**: TBD
|
||||
- **Dependencies**: TBD
|
||||
|
||||
## Description
|
||||
Add trace context propagation:
|
||||
|
||||
## Requirements
|
||||
- Add trace context propagation:
|
||||
|
||||
## Implementation Steps
|
||||
1. TODO: Add implementation steps
|
||||
2. TODO: Add implementation steps
|
||||
3. TODO: Add implementation steps
|
||||
|
||||
## Acceptance Criteria
|
||||
- [ ] Task 6.1.3 is completed
|
||||
- [ ] All requirements are met
|
||||
- [ ] Code compiles and tests pass
|
||||
|
||||
## Related ADRs
|
||||
- See relevant ADRs in `docs/adr/`
|
||||
|
||||
## Implementation Notes
|
||||
- TODO: Add implementation notes
|
||||
|
||||
## Testing
|
||||
```bash
|
||||
# TODO: Add test commands
|
||||
go test ./...
|
||||
```
|
||||
|
||||
@@ -0,0 +1,40 @@
|
||||
# Task 6.2.1: Install `github.com/getsentry/sentry-go`
|
||||
|
||||
## Metadata
|
||||
- **Task ID**: 6.2.1
|
||||
- **Title**: Install `github.com/getsentry/sentry-go`
|
||||
- **Phase**: 6 - Observability & Production Readiness
|
||||
- **Section**: 6.2
|
||||
- **Status**: Pending
|
||||
- **Priority**: High
|
||||
- **Estimated Time**: TBD
|
||||
- **Dependencies**: TBD
|
||||
|
||||
## Description
|
||||
Install `github.com/getsentry/sentry-go`
|
||||
|
||||
## Requirements
|
||||
- Install `github.com/getsentry/sentry-go`
|
||||
|
||||
## Implementation Steps
|
||||
1. TODO: Add implementation steps
|
||||
2. TODO: Add implementation steps
|
||||
3. TODO: Add implementation steps
|
||||
|
||||
## Acceptance Criteria
|
||||
- [ ] Task 6.2.1 is completed
|
||||
- [ ] All requirements are met
|
||||
- [ ] Code compiles and tests pass
|
||||
|
||||
## Related ADRs
|
||||
- See relevant ADRs in `docs/adr/`
|
||||
|
||||
## Implementation Notes
|
||||
- TODO: Add implementation notes
|
||||
|
||||
## Testing
|
||||
```bash
|
||||
# TODO: Add test commands
|
||||
go test ./...
|
||||
```
|
||||
|
||||
@@ -0,0 +1,40 @@
|
||||
# Task 6.2.2: Integrate with error bus:
|
||||
|
||||
## Metadata
|
||||
- **Task ID**: 6.2.2
|
||||
- **Title**: Integrate with error bus:
|
||||
- **Phase**: 6 - Observability & Production Readiness
|
||||
- **Section**: 6.2
|
||||
- **Status**: Pending
|
||||
- **Priority**: High
|
||||
- **Estimated Time**: TBD
|
||||
- **Dependencies**: TBD
|
||||
|
||||
## Description
|
||||
Integrate with error bus:
|
||||
|
||||
## Requirements
|
||||
- Integrate with error bus:
|
||||
|
||||
## Implementation Steps
|
||||
1. TODO: Add implementation steps
|
||||
2. TODO: Add implementation steps
|
||||
3. TODO: Add implementation steps
|
||||
|
||||
## Acceptance Criteria
|
||||
- [ ] Task 6.2.2 is completed
|
||||
- [ ] All requirements are met
|
||||
- [ ] Code compiles and tests pass
|
||||
|
||||
## Related ADRs
|
||||
- See relevant ADRs in `docs/adr/`
|
||||
|
||||
## Implementation Notes
|
||||
- TODO: Add implementation notes
|
||||
|
||||
## Testing
|
||||
```bash
|
||||
# TODO: Add test commands
|
||||
go test ./...
|
||||
```
|
||||
|
||||
40
docs/content/stories/phase6/6.2.3-add-sentry-middleware.md
Normal file
40
docs/content/stories/phase6/6.2.3-add-sentry-middleware.md
Normal file
@@ -0,0 +1,40 @@
|
||||
# Task 6.2.3: Add Sentry middleware:
|
||||
|
||||
## Metadata
|
||||
- **Task ID**: 6.2.3
|
||||
- **Title**: Add Sentry middleware:
|
||||
- **Phase**: 6 - Observability & Production Readiness
|
||||
- **Section**: 6.2
|
||||
- **Status**: Pending
|
||||
- **Priority**: High
|
||||
- **Estimated Time**: TBD
|
||||
- **Dependencies**: TBD
|
||||
|
||||
## Description
|
||||
Add Sentry middleware:
|
||||
|
||||
## Requirements
|
||||
- Add Sentry middleware:
|
||||
|
||||
## Implementation Steps
|
||||
1. TODO: Add implementation steps
|
||||
2. TODO: Add implementation steps
|
||||
3. TODO: Add implementation steps
|
||||
|
||||
## Acceptance Criteria
|
||||
- [ ] Task 6.2.3 is completed
|
||||
- [ ] All requirements are met
|
||||
- [ ] Code compiles and tests pass
|
||||
|
||||
## Related ADRs
|
||||
- See relevant ADRs in `docs/adr/`
|
||||
|
||||
## Implementation Notes
|
||||
- TODO: Add implementation notes
|
||||
|
||||
## Testing
|
||||
```bash
|
||||
# TODO: Add test commands
|
||||
go test ./...
|
||||
```
|
||||
|
||||
@@ -0,0 +1,40 @@
|
||||
# Task 6.2.4: Configure Sentry DSN via config
|
||||
|
||||
## Metadata
|
||||
- **Task ID**: 6.2.4
|
||||
- **Title**: Configure Sentry DSN via config
|
||||
- **Phase**: 6 - Observability & Production Readiness
|
||||
- **Section**: 6.2
|
||||
- **Status**: Pending
|
||||
- **Priority**: High
|
||||
- **Estimated Time**: TBD
|
||||
- **Dependencies**: TBD
|
||||
|
||||
## Description
|
||||
Configure Sentry DSN via config
|
||||
|
||||
## Requirements
|
||||
- Configure Sentry DSN via config
|
||||
|
||||
## Implementation Steps
|
||||
1. TODO: Add implementation steps
|
||||
2. TODO: Add implementation steps
|
||||
3. TODO: Add implementation steps
|
||||
|
||||
## Acceptance Criteria
|
||||
- [ ] Task 6.2.4 is completed
|
||||
- [ ] All requirements are met
|
||||
- [ ] Code compiles and tests pass
|
||||
|
||||
## Related ADRs
|
||||
- See relevant ADRs in `docs/adr/`
|
||||
|
||||
## Implementation Notes
|
||||
- TODO: Add implementation notes
|
||||
|
||||
## Testing
|
||||
```bash
|
||||
# TODO: Add test commands
|
||||
go test ./...
|
||||
```
|
||||
|
||||
40
docs/content/stories/phase6/6.3.1-add-request-correlation.md
Normal file
40
docs/content/stories/phase6/6.3.1-add-request-correlation.md
Normal file
@@ -0,0 +1,40 @@
|
||||
# Task 6.3.1: Add request correlation:
|
||||
|
||||
## Metadata
|
||||
- **Task ID**: 6.3.1
|
||||
- **Title**: Add request correlation:
|
||||
- **Phase**: 6 - Observability & Production Readiness
|
||||
- **Section**: 6.3
|
||||
- **Status**: Pending
|
||||
- **Priority**: High
|
||||
- **Estimated Time**: TBD
|
||||
- **Dependencies**: TBD
|
||||
|
||||
## Description
|
||||
Add request correlation:
|
||||
|
||||
## Requirements
|
||||
- Add request correlation:
|
||||
|
||||
## Implementation Steps
|
||||
1. TODO: Add implementation steps
|
||||
2. TODO: Add implementation steps
|
||||
3. TODO: Add implementation steps
|
||||
|
||||
## Acceptance Criteria
|
||||
- [ ] Task 6.3.1 is completed
|
||||
- [ ] All requirements are met
|
||||
- [ ] Code compiles and tests pass
|
||||
|
||||
## Related ADRs
|
||||
- See relevant ADRs in `docs/adr/`
|
||||
|
||||
## Implementation Notes
|
||||
- TODO: Add implementation notes
|
||||
|
||||
## Testing
|
||||
```bash
|
||||
# TODO: Add test commands
|
||||
go test ./...
|
||||
```
|
||||
|
||||
40
docs/content/stories/phase6/6.3.2-add-structured-fields.md
Normal file
40
docs/content/stories/phase6/6.3.2-add-structured-fields.md
Normal file
@@ -0,0 +1,40 @@
|
||||
# Task 6.3.2: Add structured fields:
|
||||
|
||||
## Metadata
|
||||
- **Task ID**: 6.3.2
|
||||
- **Title**: Add structured fields:
|
||||
- **Phase**: 6 - Observability & Production Readiness
|
||||
- **Section**: 6.3
|
||||
- **Status**: Pending
|
||||
- **Priority**: High
|
||||
- **Estimated Time**: TBD
|
||||
- **Dependencies**: TBD
|
||||
|
||||
## Description
|
||||
Add structured fields:
|
||||
|
||||
## Requirements
|
||||
- Add structured fields:
|
||||
|
||||
## Implementation Steps
|
||||
1. TODO: Add implementation steps
|
||||
2. TODO: Add implementation steps
|
||||
3. TODO: Add implementation steps
|
||||
|
||||
## Acceptance Criteria
|
||||
- [ ] Task 6.3.2 is completed
|
||||
- [ ] All requirements are met
|
||||
- [ ] Code compiles and tests pass
|
||||
|
||||
## Related ADRs
|
||||
- See relevant ADRs in `docs/adr/`
|
||||
|
||||
## Implementation Notes
|
||||
- TODO: Add implementation notes
|
||||
|
||||
## Testing
|
||||
```bash
|
||||
# TODO: Add test commands
|
||||
go test ./...
|
||||
```
|
||||
|
||||
@@ -0,0 +1,40 @@
|
||||
# Task 6.3.3: Create log aggregation config:
|
||||
|
||||
## Metadata
|
||||
- **Task ID**: 6.3.3
|
||||
- **Title**: Create log aggregation config:
|
||||
- **Phase**: 6 - Observability & Production Readiness
|
||||
- **Section**: 6.3
|
||||
- **Status**: Pending
|
||||
- **Priority**: High
|
||||
- **Estimated Time**: TBD
|
||||
- **Dependencies**: TBD
|
||||
|
||||
## Description
|
||||
Create log aggregation config:
|
||||
|
||||
## Requirements
|
||||
- Create log aggregation config:
|
||||
|
||||
## Implementation Steps
|
||||
1. TODO: Add implementation steps
|
||||
2. TODO: Add implementation steps
|
||||
3. TODO: Add implementation steps
|
||||
|
||||
## Acceptance Criteria
|
||||
- [ ] Task 6.3.3 is completed
|
||||
- [ ] All requirements are met
|
||||
- [ ] Code compiles and tests pass
|
||||
|
||||
## Related ADRs
|
||||
- See relevant ADRs in `docs/adr/`
|
||||
|
||||
## Implementation Notes
|
||||
- TODO: Add implementation notes
|
||||
|
||||
## Testing
|
||||
```bash
|
||||
# TODO: Add test commands
|
||||
go test ./...
|
||||
```
|
||||
|
||||
40
docs/content/stories/phase6/6.4.1-add-more-metrics.md
Normal file
40
docs/content/stories/phase6/6.4.1-add-more-metrics.md
Normal file
@@ -0,0 +1,40 @@
|
||||
# Task 6.4.1: Add more metrics:
|
||||
|
||||
## Metadata
|
||||
- **Task ID**: 6.4.1
|
||||
- **Title**: Add more metrics:
|
||||
- **Phase**: 6 - Observability & Production Readiness
|
||||
- **Section**: 6.4
|
||||
- **Status**: Pending
|
||||
- **Priority**: High
|
||||
- **Estimated Time**: TBD
|
||||
- **Dependencies**: TBD
|
||||
|
||||
## Description
|
||||
Add more metrics:
|
||||
|
||||
## Requirements
|
||||
- Add more metrics:
|
||||
|
||||
## Implementation Steps
|
||||
1. TODO: Add implementation steps
|
||||
2. TODO: Add implementation steps
|
||||
3. TODO: Add implementation steps
|
||||
|
||||
## Acceptance Criteria
|
||||
- [ ] Task 6.4.1 is completed
|
||||
- [ ] All requirements are met
|
||||
- [ ] Code compiles and tests pass
|
||||
|
||||
## Related ADRs
|
||||
- See relevant ADRs in `docs/adr/`
|
||||
|
||||
## Implementation Notes
|
||||
- TODO: Add implementation notes
|
||||
|
||||
## Testing
|
||||
```bash
|
||||
# TODO: Add test commands
|
||||
go test ./...
|
||||
```
|
||||
|
||||
40
docs/content/stories/phase6/6.4.2-create-metric-labels.md
Normal file
40
docs/content/stories/phase6/6.4.2-create-metric-labels.md
Normal file
@@ -0,0 +1,40 @@
|
||||
# Task 6.4.2: Create metric labels:
|
||||
|
||||
## Metadata
|
||||
- **Task ID**: 6.4.2
|
||||
- **Title**: Create metric labels:
|
||||
- **Phase**: 6 - Observability & Production Readiness
|
||||
- **Section**: 6.4
|
||||
- **Status**: Pending
|
||||
- **Priority**: High
|
||||
- **Estimated Time**: TBD
|
||||
- **Dependencies**: TBD
|
||||
|
||||
## Description
|
||||
Create metric labels:
|
||||
|
||||
## Requirements
|
||||
- Create metric labels:
|
||||
|
||||
## Implementation Steps
|
||||
1. TODO: Add implementation steps
|
||||
2. TODO: Add implementation steps
|
||||
3. TODO: Add implementation steps
|
||||
|
||||
## Acceptance Criteria
|
||||
- [ ] Task 6.4.2 is completed
|
||||
- [ ] All requirements are met
|
||||
- [ ] Code compiles and tests pass
|
||||
|
||||
## Related ADRs
|
||||
- See relevant ADRs in `docs/adr/`
|
||||
|
||||
## Implementation Notes
|
||||
- TODO: Add implementation notes
|
||||
|
||||
## Testing
|
||||
```bash
|
||||
# TODO: Add test commands
|
||||
go test ./...
|
||||
```
|
||||
|
||||
@@ -0,0 +1,40 @@
|
||||
# Task 6.5.1: Create `ops/grafana/dashboards/`:
|
||||
|
||||
## Metadata
|
||||
- **Task ID**: 6.5.1
|
||||
- **Title**: Create `ops/grafana/dashboards/`:
|
||||
- **Phase**: 6 - Observability & Production Readiness
|
||||
- **Section**: 6.5
|
||||
- **Status**: Pending
|
||||
- **Priority**: High
|
||||
- **Estimated Time**: TBD
|
||||
- **Dependencies**: TBD
|
||||
|
||||
## Description
|
||||
Create `ops/grafana/dashboards/`:
|
||||
|
||||
## Requirements
|
||||
- Create `ops/grafana/dashboards/`:
|
||||
|
||||
## Implementation Steps
|
||||
1. TODO: Add implementation steps
|
||||
2. TODO: Add implementation steps
|
||||
3. TODO: Add implementation steps
|
||||
|
||||
## Acceptance Criteria
|
||||
- [ ] Task 6.5.1 is completed
|
||||
- [ ] All requirements are met
|
||||
- [ ] Code compiles and tests pass
|
||||
|
||||
## Related ADRs
|
||||
- See relevant ADRs in `docs/adr/`
|
||||
|
||||
## Implementation Notes
|
||||
- TODO: Add implementation notes
|
||||
|
||||
## Testing
|
||||
```bash
|
||||
# TODO: Add test commands
|
||||
go test ./...
|
||||
```
|
||||
|
||||
@@ -0,0 +1,40 @@
|
||||
# Task 6.5.2: Document dashboard setup in `docs/operations.md`
|
||||
|
||||
## Metadata
|
||||
- **Task ID**: 6.5.2
|
||||
- **Title**: Document dashboard setup in `docs/operations.md`
|
||||
- **Phase**: 6 - Observability & Production Readiness
|
||||
- **Section**: 6.5
|
||||
- **Status**: Pending
|
||||
- **Priority**: High
|
||||
- **Estimated Time**: TBD
|
||||
- **Dependencies**: TBD
|
||||
|
||||
## Description
|
||||
Document dashboard setup in `docs/operations.md`
|
||||
|
||||
## Requirements
|
||||
- Document dashboard setup in `docs/operations.md`
|
||||
|
||||
## Implementation Steps
|
||||
1. TODO: Add implementation steps
|
||||
2. TODO: Add implementation steps
|
||||
3. TODO: Add implementation steps
|
||||
|
||||
## Acceptance Criteria
|
||||
- [ ] Task 6.5.2 is completed
|
||||
- [ ] All requirements are met
|
||||
- [ ] Code compiles and tests pass
|
||||
|
||||
## Related ADRs
|
||||
- See relevant ADRs in `docs/adr/`
|
||||
|
||||
## Implementation Notes
|
||||
- TODO: Add implementation notes
|
||||
|
||||
## Testing
|
||||
```bash
|
||||
# TODO: Add test commands
|
||||
go test ./...
|
||||
```
|
||||
|
||||
@@ -0,0 +1,40 @@
|
||||
# Task 6.6.1: Install `github.com/ulule/limiter/v3`
|
||||
|
||||
## Metadata
|
||||
- **Task ID**: 6.6.1
|
||||
- **Title**: Install `github.com/ulule/limiter/v3`
|
||||
- **Phase**: 6 - Observability & Production Readiness
|
||||
- **Section**: 6.6
|
||||
- **Status**: Pending
|
||||
- **Priority**: High
|
||||
- **Estimated Time**: TBD
|
||||
- **Dependencies**: TBD
|
||||
|
||||
## Description
|
||||
Install `github.com/ulule/limiter/v3`
|
||||
|
||||
## Requirements
|
||||
- Install `github.com/ulule/limiter/v3`
|
||||
|
||||
## Implementation Steps
|
||||
1. TODO: Add implementation steps
|
||||
2. TODO: Add implementation steps
|
||||
3. TODO: Add implementation steps
|
||||
|
||||
## Acceptance Criteria
|
||||
- [ ] Task 6.6.1 is completed
|
||||
- [ ] All requirements are met
|
||||
- [ ] Code compiles and tests pass
|
||||
|
||||
## Related ADRs
|
||||
- See relevant ADRs in `docs/adr/`
|
||||
|
||||
## Implementation Notes
|
||||
- TODO: Add implementation notes
|
||||
|
||||
## Testing
|
||||
```bash
|
||||
# TODO: Add test commands
|
||||
go test ./...
|
||||
```
|
||||
|
||||
@@ -0,0 +1,40 @@
|
||||
# Task 6.6.2: Create rate limit middleware:
|
||||
|
||||
## Metadata
|
||||
- **Task ID**: 6.6.2
|
||||
- **Title**: Create rate limit middleware:
|
||||
- **Phase**: 6 - Observability & Production Readiness
|
||||
- **Section**: 6.6
|
||||
- **Status**: Pending
|
||||
- **Priority**: High
|
||||
- **Estimated Time**: TBD
|
||||
- **Dependencies**: TBD
|
||||
|
||||
## Description
|
||||
Create rate limit middleware:
|
||||
|
||||
## Requirements
|
||||
- Create rate limit middleware:
|
||||
|
||||
## Implementation Steps
|
||||
1. TODO: Add implementation steps
|
||||
2. TODO: Add implementation steps
|
||||
3. TODO: Add implementation steps
|
||||
|
||||
## Acceptance Criteria
|
||||
- [ ] Task 6.6.2 is completed
|
||||
- [ ] All requirements are met
|
||||
- [ ] Code compiles and tests pass
|
||||
|
||||
## Related ADRs
|
||||
- See relevant ADRs in `docs/adr/`
|
||||
|
||||
## Implementation Notes
|
||||
- TODO: Add implementation notes
|
||||
|
||||
## Testing
|
||||
```bash
|
||||
# TODO: Add test commands
|
||||
go test ./...
|
||||
```
|
||||
|
||||
49
docs/content/stories/phase6/6.6.3-add-rate-limit-config.md
Normal file
49
docs/content/stories/phase6/6.6.3-add-rate-limit-config.md
Normal file
@@ -0,0 +1,49 @@
|
||||
# Task 6.6.3: Add rate limit config:
|
||||
|
||||
## Metadata
|
||||
- **Task ID**: 6.6.3
|
||||
- **Title**: Add rate limit config:
|
||||
- **Phase**: 6 - Observability & Production Readiness
|
||||
- **Section**: 6.6
|
||||
- **Status**: Pending
|
||||
- **Priority**: High
|
||||
- **Estimated Time**: TBD
|
||||
- **Dependencies**: TBD
|
||||
|
||||
## Description
|
||||
Add rate limit config:
|
||||
|
||||
## Requirements
|
||||
- Add rate limit config:
|
||||
|
||||
## Implementation Steps
|
||||
1. TODO: Add implementation steps
|
||||
2. TODO: Add implementation steps
|
||||
3. TODO: Add implementation steps
|
||||
|
||||
## Acceptance Criteria
|
||||
- [ ] Task 6.6.3 is completed
|
||||
- [ ] All requirements are met
|
||||
- [ ] Code compiles and tests pass
|
||||
|
||||
## Related ADRs
|
||||
- See relevant ADRs in `docs/adr/`
|
||||
|
||||
## Implementation Notes
|
||||
- TODO: Add implementation notes
|
||||
|
||||
## Testing
|
||||
```bash
|
||||
# TODO: Add test commands
|
||||
go test ./...
|
||||
```
|
||||
|
||||
|
||||
## Code Reference
|
||||
|
||||
```go
|
||||
rate_limiting:
|
||||
enabled: true
|
||||
per_user: 100/minute
|
||||
per_ip: 1000/minute
|
||||
```
|
||||
@@ -0,0 +1,40 @@
|
||||
# Task 6.6.4: Return `X-RateLimit-*` headers
|
||||
|
||||
## Metadata
|
||||
- **Task ID**: 6.6.4
|
||||
- **Title**: Return `X-RateLimit-*` headers
|
||||
- **Phase**: 6 - Observability & Production Readiness
|
||||
- **Section**: 6.6
|
||||
- **Status**: Pending
|
||||
- **Priority**: High
|
||||
- **Estimated Time**: TBD
|
||||
- **Dependencies**: TBD
|
||||
|
||||
## Description
|
||||
Return `X-RateLimit-*` headers
|
||||
|
||||
## Requirements
|
||||
- Return `X-RateLimit-*` headers
|
||||
|
||||
## Implementation Steps
|
||||
1. TODO: Add implementation steps
|
||||
2. TODO: Add implementation steps
|
||||
3. TODO: Add implementation steps
|
||||
|
||||
## Acceptance Criteria
|
||||
- [ ] Task 6.6.4 is completed
|
||||
- [ ] All requirements are met
|
||||
- [ ] Code compiles and tests pass
|
||||
|
||||
## Related ADRs
|
||||
- See relevant ADRs in `docs/adr/`
|
||||
|
||||
## Implementation Notes
|
||||
- TODO: Add implementation notes
|
||||
|
||||
## Testing
|
||||
```bash
|
||||
# TODO: Add test commands
|
||||
go test ./...
|
||||
```
|
||||
|
||||
@@ -0,0 +1,40 @@
|
||||
# Task 6.7.1: Add security headers middleware:
|
||||
|
||||
## Metadata
|
||||
- **Task ID**: 6.7.1
|
||||
- **Title**: Add security headers middleware:
|
||||
- **Phase**: 6 - Observability & Production Readiness
|
||||
- **Section**: 6.7
|
||||
- **Status**: Pending
|
||||
- **Priority**: High
|
||||
- **Estimated Time**: TBD
|
||||
- **Dependencies**: TBD
|
||||
|
||||
## Description
|
||||
Add security headers middleware:
|
||||
|
||||
## Requirements
|
||||
- Add security headers middleware:
|
||||
|
||||
## Implementation Steps
|
||||
1. TODO: Add implementation steps
|
||||
2. TODO: Add implementation steps
|
||||
3. TODO: Add implementation steps
|
||||
|
||||
## Acceptance Criteria
|
||||
- [ ] Task 6.7.1 is completed
|
||||
- [ ] All requirements are met
|
||||
- [ ] Code compiles and tests pass
|
||||
|
||||
## Related ADRs
|
||||
- See relevant ADRs in `docs/adr/`
|
||||
|
||||
## Implementation Notes
|
||||
- TODO: Add implementation notes
|
||||
|
||||
## Testing
|
||||
```bash
|
||||
# TODO: Add test commands
|
||||
go test ./...
|
||||
```
|
||||
|
||||
40
docs/content/stories/phase6/6.7.2-add-request-size-limits.md
Normal file
40
docs/content/stories/phase6/6.7.2-add-request-size-limits.md
Normal file
@@ -0,0 +1,40 @@
|
||||
# Task 6.7.2: Add request size limits:
|
||||
|
||||
## Metadata
|
||||
- **Task ID**: 6.7.2
|
||||
- **Title**: Add request size limits:
|
||||
- **Phase**: 6 - Observability & Production Readiness
|
||||
- **Section**: 6.7
|
||||
- **Status**: Pending
|
||||
- **Priority**: High
|
||||
- **Estimated Time**: TBD
|
||||
- **Dependencies**: TBD
|
||||
|
||||
## Description
|
||||
Add request size limits:
|
||||
|
||||
## Requirements
|
||||
- Add request size limits:
|
||||
|
||||
## Implementation Steps
|
||||
1. TODO: Add implementation steps
|
||||
2. TODO: Add implementation steps
|
||||
3. TODO: Add implementation steps
|
||||
|
||||
## Acceptance Criteria
|
||||
- [ ] Task 6.7.2 is completed
|
||||
- [ ] All requirements are met
|
||||
- [ ] Code compiles and tests pass
|
||||
|
||||
## Related ADRs
|
||||
- See relevant ADRs in `docs/adr/`
|
||||
|
||||
## Implementation Notes
|
||||
- TODO: Add implementation notes
|
||||
|
||||
## Testing
|
||||
```bash
|
||||
# TODO: Add test commands
|
||||
go test ./...
|
||||
```
|
||||
|
||||
40
docs/content/stories/phase6/6.7.3-add-input-validation.md
Normal file
40
docs/content/stories/phase6/6.7.3-add-input-validation.md
Normal file
@@ -0,0 +1,40 @@
|
||||
# Task 6.7.3: Add input validation:
|
||||
|
||||
## Metadata
|
||||
- **Task ID**: 6.7.3
|
||||
- **Title**: Add input validation:
|
||||
- **Phase**: 6 - Observability & Production Readiness
|
||||
- **Section**: 6.7
|
||||
- **Status**: Pending
|
||||
- **Priority**: High
|
||||
- **Estimated Time**: TBD
|
||||
- **Dependencies**: TBD
|
||||
|
||||
## Description
|
||||
Add input validation:
|
||||
|
||||
## Requirements
|
||||
- Add input validation:
|
||||
|
||||
## Implementation Steps
|
||||
1. TODO: Add implementation steps
|
||||
2. TODO: Add implementation steps
|
||||
3. TODO: Add implementation steps
|
||||
|
||||
## Acceptance Criteria
|
||||
- [ ] Task 6.7.3 is completed
|
||||
- [ ] All requirements are met
|
||||
- [ ] Code compiles and tests pass
|
||||
|
||||
## Related ADRs
|
||||
- See relevant ADRs in `docs/adr/`
|
||||
|
||||
## Implementation Notes
|
||||
- TODO: Add implementation notes
|
||||
|
||||
## Testing
|
||||
```bash
|
||||
# TODO: Add test commands
|
||||
go test ./...
|
||||
```
|
||||
|
||||
@@ -0,0 +1,40 @@
|
||||
# Task 6.7.4: Add SQL injection protection:
|
||||
|
||||
## Metadata
|
||||
- **Task ID**: 6.7.4
|
||||
- **Title**: Add SQL injection protection:
|
||||
- **Phase**: 6 - Observability & Production Readiness
|
||||
- **Section**: 6.7
|
||||
- **Status**: Pending
|
||||
- **Priority**: High
|
||||
- **Estimated Time**: TBD
|
||||
- **Dependencies**: TBD
|
||||
|
||||
## Description
|
||||
Add SQL injection protection:
|
||||
|
||||
## Requirements
|
||||
- Add SQL injection protection:
|
||||
|
||||
## Implementation Steps
|
||||
1. TODO: Add implementation steps
|
||||
2. TODO: Add implementation steps
|
||||
3. TODO: Add implementation steps
|
||||
|
||||
## Acceptance Criteria
|
||||
- [ ] Task 6.7.4 is completed
|
||||
- [ ] All requirements are met
|
||||
- [ ] Code compiles and tests pass
|
||||
|
||||
## Related ADRs
|
||||
- See relevant ADRs in `docs/adr/`
|
||||
|
||||
## Implementation Notes
|
||||
- TODO: Add implementation notes
|
||||
|
||||
## Testing
|
||||
```bash
|
||||
# TODO: Add test commands
|
||||
go test ./...
|
||||
```
|
||||
|
||||
@@ -0,0 +1,40 @@
|
||||
# Task 6.8.1: Add database connection pooling:
|
||||
|
||||
## Metadata
|
||||
- **Task ID**: 6.8.1
|
||||
- **Title**: Add database connection pooling:
|
||||
- **Phase**: 6 - Observability & Production Readiness
|
||||
- **Section**: 6.8
|
||||
- **Status**: Pending
|
||||
- **Priority**: High
|
||||
- **Estimated Time**: TBD
|
||||
- **Dependencies**: TBD
|
||||
|
||||
## Description
|
||||
Add database connection pooling:
|
||||
|
||||
## Requirements
|
||||
- Add database connection pooling:
|
||||
|
||||
## Implementation Steps
|
||||
1. TODO: Add implementation steps
|
||||
2. TODO: Add implementation steps
|
||||
3. TODO: Add implementation steps
|
||||
|
||||
## Acceptance Criteria
|
||||
- [ ] Task 6.8.1 is completed
|
||||
- [ ] All requirements are met
|
||||
- [ ] Code compiles and tests pass
|
||||
|
||||
## Related ADRs
|
||||
- See relevant ADRs in `docs/adr/`
|
||||
|
||||
## Implementation Notes
|
||||
- TODO: Add implementation notes
|
||||
|
||||
## Testing
|
||||
```bash
|
||||
# TODO: Add test commands
|
||||
go test ./...
|
||||
```
|
||||
|
||||
40
docs/content/stories/phase6/6.8.2-add-query-optimization.md
Normal file
40
docs/content/stories/phase6/6.8.2-add-query-optimization.md
Normal file
@@ -0,0 +1,40 @@
|
||||
# Task 6.8.2: Add query optimization:
|
||||
|
||||
## Metadata
|
||||
- **Task ID**: 6.8.2
|
||||
- **Title**: Add query optimization:
|
||||
- **Phase**: 6 - Observability & Production Readiness
|
||||
- **Section**: 6.8
|
||||
- **Status**: Pending
|
||||
- **Priority**: High
|
||||
- **Estimated Time**: TBD
|
||||
- **Dependencies**: TBD
|
||||
|
||||
## Description
|
||||
Add query optimization:
|
||||
|
||||
## Requirements
|
||||
- Add query optimization:
|
||||
|
||||
## Implementation Steps
|
||||
1. TODO: Add implementation steps
|
||||
2. TODO: Add implementation steps
|
||||
3. TODO: Add implementation steps
|
||||
|
||||
## Acceptance Criteria
|
||||
- [ ] Task 6.8.2 is completed
|
||||
- [ ] All requirements are met
|
||||
- [ ] Code compiles and tests pass
|
||||
|
||||
## Related ADRs
|
||||
- See relevant ADRs in `docs/adr/`
|
||||
|
||||
## Implementation Notes
|
||||
- TODO: Add implementation notes
|
||||
|
||||
## Testing
|
||||
```bash
|
||||
# TODO: Add test commands
|
||||
go test ./...
|
||||
```
|
||||
|
||||
@@ -0,0 +1,40 @@
|
||||
# Task 6.8.3: Add response compression:
|
||||
|
||||
## Metadata
|
||||
- **Task ID**: 6.8.3
|
||||
- **Title**: Add response compression:
|
||||
- **Phase**: 6 - Observability & Production Readiness
|
||||
- **Section**: 6.8
|
||||
- **Status**: Pending
|
||||
- **Priority**: High
|
||||
- **Estimated Time**: TBD
|
||||
- **Dependencies**: TBD
|
||||
|
||||
## Description
|
||||
Add response compression:
|
||||
|
||||
## Requirements
|
||||
- Add response compression:
|
||||
|
||||
## Implementation Steps
|
||||
1. TODO: Add implementation steps
|
||||
2. TODO: Add implementation steps
|
||||
3. TODO: Add implementation steps
|
||||
|
||||
## Acceptance Criteria
|
||||
- [ ] Task 6.8.3 is completed
|
||||
- [ ] All requirements are met
|
||||
- [ ] Code compiles and tests pass
|
||||
|
||||
## Related ADRs
|
||||
- See relevant ADRs in `docs/adr/`
|
||||
|
||||
## Implementation Notes
|
||||
- TODO: Add implementation notes
|
||||
|
||||
## Testing
|
||||
```bash
|
||||
# TODO: Add test commands
|
||||
go test ./...
|
||||
```
|
||||
|
||||
40
docs/content/stories/phase6/6.8.4-add-caching-strategy.md
Normal file
40
docs/content/stories/phase6/6.8.4-add-caching-strategy.md
Normal file
@@ -0,0 +1,40 @@
|
||||
# Task 6.8.4: Add caching strategy:
|
||||
|
||||
## Metadata
|
||||
- **Task ID**: 6.8.4
|
||||
- **Title**: Add caching strategy:
|
||||
- **Phase**: 6 - Observability & Production Readiness
|
||||
- **Section**: 6.8
|
||||
- **Status**: Pending
|
||||
- **Priority**: High
|
||||
- **Estimated Time**: TBD
|
||||
- **Dependencies**: TBD
|
||||
|
||||
## Description
|
||||
Add caching strategy:
|
||||
|
||||
## Requirements
|
||||
- Add caching strategy:
|
||||
|
||||
## Implementation Steps
|
||||
1. TODO: Add implementation steps
|
||||
2. TODO: Add implementation steps
|
||||
3. TODO: Add implementation steps
|
||||
|
||||
## Acceptance Criteria
|
||||
- [ ] Task 6.8.4 is completed
|
||||
- [ ] All requirements are met
|
||||
- [ ] Code compiles and tests pass
|
||||
|
||||
## Related ADRs
|
||||
- See relevant ADRs in `docs/adr/`
|
||||
|
||||
## Implementation Notes
|
||||
- TODO: Add implementation notes
|
||||
|
||||
## Testing
|
||||
```bash
|
||||
# TODO: Add test commands
|
||||
go test ./...
|
||||
```
|
||||
|
||||
48
docs/content/stories/phase6/README.md
Normal file
48
docs/content/stories/phase6/README.md
Normal 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
|
||||
|
||||
Reference in New Issue
Block a user