- Added `FilesystemPackRunProvenanceWriter` to write provenance manifests to the filesystem. - Introduced `MongoPackRunArtifactReader` to read artifacts from MongoDB. - Created `MongoPackRunProvenanceWriter` to store provenance manifests in MongoDB. - Developed unit tests for filesystem and MongoDB provenance writers. - Established `ITimelineEventStore` and `ITimelineIngestionService` interfaces for timeline event handling. - Implemented `TimelineIngestionService` to validate and persist timeline events with hashing. - Created PostgreSQL schema and migration scripts for timeline indexing. - Added dependency injection support for timeline indexer services. - Developed tests for timeline ingestion and schema validation.
2.5 KiB
2.5 KiB
Telemetry agent guide
Mission
Telemetry module captures deployment and operations guidance for the shared observability stack (collectors, storage, dashboards).
Advisory Handling
- Any new/updated advisory triggers immediate doc + sprint updates; no approval.
- Update high-level + detailed docs; inline only short snippets; place runnable/long code in
docs/benchmarks/**ortests/**(deterministic/offline) and link. - Add tasks + Execution Log entries in relevant
SPRINT_*.mdwith doc paths/owners; add risks if schema/feed/transparency caps apply. - Check archived advisories; mark supersedes/extends if overlapping.
- Defaults: hybrid reachability, deterministic/frozen feeds; act first, report after.
Key docs
- Module README
- Architecture
- Implementation plan
- Task board
- Observability runbook (offline import friendly)
How to get started
- Open sprint file
/docs/implplan/SPRINT_*.mdand locate the stories referencing this module. - Review ./TASKS.md for local follow-ups and confirm status transitions (TODO → DOING → DONE/BLOCKED).
- Read the architecture and README for domain context before editing code or docs.
- Coordinate cross-module changes in the main /AGENTS.md description and through the sprint plan.
Guardrails
- Honour the Aggregation-Only Contract where applicable (see ../../ingestion/aggregation-only-contract.md).
- Preserve determinism: sort outputs, normalise timestamps (UTC ISO-8601), and avoid machine-specific artefacts.
- Keep Offline Kit parity in mind—document air-gapped workflows for any new feature.
- Update runbooks/observability assets when operational characteristics change.
Required Reading
docs/modules/telemetry/README.mddocs/modules/telemetry/architecture.mddocs/modules/telemetry/implementation_plan.mddocs/modules/platform/architecture-overview.md
Working Agreement
-
- Update task status to
DOING/DONEin both correspoding sprint file/docs/implplan/SPRINT_*.mdand the localTASKS.mdwhen you start or finish work.
- Update task status to
-
- Review this charter and the Required Reading documents before coding; confirm prerequisites are met.
-
- Keep changes deterministic (stable ordering, timestamps, hashes) and align with offline/air-gap expectations.
-
- Coordinate doc updates, tests, and cross-guild communication whenever contracts or workflows change.
-
- Revert to
TODOif you pause the task without shipping changes; leave notes in commit/PR descriptions for context.
- Revert to