feat: Document completed tasks for KMS, Cryptography, and Plugin Libraries
Some checks failed
Docs CI / lint-and-preview (push) Has been cancelled
Some checks failed
Docs CI / lint-and-preview (push) Has been cancelled
- Added detailed task completion records for KMS interface implementation and CLI support for file-based keys. - Documented security enhancements including Argon2id password hashing, audit event contracts, and rate limiting configurations. - Included scoped service support and integration updates for the Plugin platform, ensuring proper DI handling and testing coverage.
This commit is contained in:
29
docs/technical/observability/README.md
Normal file
29
docs/technical/observability/README.md
Normal file
@@ -0,0 +1,29 @@
|
||||
# Observability, Notifications & Telemetry
|
||||
|
||||
Guides for capturing metrics, logs, traces, and delivering notifications.
|
||||
|
||||
## Observability Stack
|
||||
- [../observability/observability.md](../../observability/observability.md) – AOC observability overview.
|
||||
- [../observability/policy.md](../../observability/policy.md) – policy-specific telemetry guidance.
|
||||
- [../observability/ui-telemetry.md](../../observability/ui-telemetry.md) – UI instrumentation and SSE tracing.
|
||||
- Telemetry module docs: [../../modules/telemetry/architecture.md](../../modules/telemetry/architecture.md), [../../modules/telemetry/implementation_plan.md](../../modules/telemetry/implementation_plan.md), [../../modules/telemetry/operations/collector.md](../../modules/telemetry/operations/collector.md), [../../modules/telemetry/operations/storage.md](../../modules/telemetry/operations/storage.md).
|
||||
- Authority / Scanner dashboards: see respective module `operations/*.json` and Grafana runbooks.
|
||||
|
||||
## Events & Streaming
|
||||
- [../events/README.md](../../events/README.md) – canonical event definitions.
|
||||
- Payload schemas (JSON): [../events/scanner.scan.completed@1.json](../../events/scanner.scan.completed@1.json), [../events/scanner.report.ready@1.json](../../events/scanner.report.ready@1.json), [../events/scheduler.rescan.delta@1.json](../../events/scheduler.rescan.delta@1.json), [../events/attestor.logged@1.json](../../events/attestor.logged@1.json), etc.
|
||||
- [../events/samples/](../../events/samples/) – sample payloads with validation workflow.
|
||||
- [../../modules/export-center/provenance-and-signing.md](../../modules/export-center/provenance-and-signing.md) – provenance event integration.
|
||||
|
||||
## Notifications Studio
|
||||
- [../notifications/overview.md](../../notifications/overview.md) – architecture and channels.
|
||||
- [../notifications/rules.md](../../notifications/rules.md) – rule authoring.
|
||||
- [../notifications/templates.md](../../notifications/templates.md) – template management.
|
||||
- [../notifications/digests.md](../../notifications/digests.md) – digest scheduling.
|
||||
- [../../modules/notify/architecture.md](../../modules/notify/architecture.md) & [../../modules/notify/implementation_plan.md](../../modules/notify/implementation_plan.md) – implementation detail.
|
||||
|
||||
## Metrics & Dashboards
|
||||
- Scanner analyzers dashboard: [../../modules/scanner/operations/analyzers-grafana-dashboard.json](../../modules/scanner/operations/analyzers-grafana-dashboard.json).
|
||||
- Scheduler worker dashboards & alert rules: [../../modules/scheduler/operations/worker-grafana-dashboard.json](../../modules/scheduler/operations/worker-grafana-dashboard.json), [../../modules/scheduler/operations/worker-prometheus-rules.yaml](../../modules/scheduler/operations/worker-prometheus-rules.yaml).
|
||||
- Authority monitoring: [../../modules/authority/operations/monitoring.md](../../modules/authority/operations/monitoring.md).
|
||||
- DevOps observability tasks: see [../../modules/devops/architecture.md](../../modules/devops/architecture.md) and runbooks.
|
||||
Reference in New Issue
Block a user