Files
kami 9734eec63c docs: add module documentation in AsciiDoc with PlantUML diagrams
Generated by per-group subagents covering all 52 modules across:
core (18), infrastructure (10), apps (5), interfaces (3),
plugins (7), testing (9)

Documentation format:
- AsciiDoc (.adoc) files in docs/modules/<group>/
- PlantUML (.puml) files in docs/diagrams/
- .adoc files reference diagrams via include:: directives

Each doc covers: purpose, responsibilities, non-responsibilities,
key types, event flow, integration points, invariants, PlantUML
diagram, known issues, and open questions.
2026-05-26 16:59:21 +04:00

56 lines
1.4 KiB
Plaintext

= infra-telemetry
== purpose
Placeholder module reserved for telemetry infrastructure — metrics collection, structured logging, tracing export, and monitoring integration. Currently contains only a `Module` marker object with no implementation.
== responsibilities
* Intended: implement metrics collection (counters, gauges, histograms)
* Intended: provide log shipping and structured log formatting
* Intended: export distributed tracing data
* Intended: integrate with monitoring backends (Prometheus, OpenTelemetry, etc.)
== non-responsibilities
* Does not define observability contracts — that belongs to `core:observability`
* Does not implement application-level instrumentation — that belongs to individual modules
* Does not store or query telemetry data long-term
== key types
=== Module
* **kind**: object
* **purpose**: Module marker for the Gradle subproject; no behavior.
== event flow
*None.* No events are consumed or emitted. This is a placeholder.
== integration points
No integration points. The module has no dependencies beyond `core:events`.
== invariants
None — module is empty.
== PlantUML diagram
[plantuml, infra-telemetry, "png"]
----
include::../../diagrams/infra-telemetry.puml[]
----
== known issues
Module is a placeholder — no telemetry infrastructure exists.
== open questions
* Which telemetry backend will be used (Prometheus, OpenTelemetry, Datadog)?
* Will telemetry be synchronous (side-channel) or event-sourced?