neon-sprawl/docs/decomposition/modules/E9_M1_TelemetryEventSchema.md

2.3 KiB

E9.M1 — TelemetryEventSchema

Summary

Field Value
Module ID E9.M1
Epic Epic 9 — LiveOps / Integrity
Stage target Prototype
Status Planned (see dependency register)

Purpose

Artifact policy for telemetry (envelope, field naming, versioning) aligns with contracts.md — contract kinds and Telemetry row.

Canonical taxonomy and versioning for gameplay and operations events: session, progression, economy, combat, PvP, movement desync, and integrity-adjacent signals. Provides the shared envelope so every epic can instrument consistently and breaking changes are explicit.

Responsibilities

  • Define TelemetryEvent shapes (or schema IDs) and required context fields.
  • Govern EventSchemaVersion and migration rules for ingest pipelines.
  • Specify ClientEventEnvelope (batching, privacy guardrails, delivery semantics) for prototype SDK.

Key contracts

Contract Role
TelemetryEvent Named event with versioned payload; single registry or catalog.
EventSchemaVersion Bump policy when fields or semantics change.
ClientEventEnvelope Transport wrapper: timestamps, session, sampling, PII policy hooks.

Module dependencies

  • None — horizontal capability; other modules depend on E9.M1 for event names and fields.

Dependents (by design)

  • E9.M2 — KpiDashboardsAndAlerting: aggregates and gates.
  • E9.M4 — IntegrityAndAbuseResponse: correlates signals to incidents.
  • All epics — Slices reference concrete events (e.g. xp_grant, zone_enter, pvp_state_changed) once schema exists.

See Epic 9 Slice 1 — Baseline event SDK and schema versioning: prototype funnel events match master plan baseline; breaking changes versioned; telemetry for schema_version_mismatch and ingest errors.

Risks and telemetry

  • Noise drowning signals: decision-driven instrumentation, sampling strategy from master plan.
  • Privacy: guardrails in envelope and field catalog before wide client shipment.

Source anchors