telemetry-contracts

Maintain telemetry contract stability across event names, JSONL envelopes, and status endpoints.

1|Updated Sep 12, 2025
One-click install
npx skills add https://github.com/metabench/copilot-dl-news --skill telemetry-contracts-metabench
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: telemetry-contracts
Source: https://github.com/metabench/copilot-dl-news/tree/main/docs/agi/skills/telemetry-contracts
Command: npx skills add https://github.com/metabench/copilot-dl-news --skill telemetry-contracts-metabench

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve? Telemetry contracts drift silently when event names change, JSONL envelope shapes evolve, or /api/health and /api/status payloads are modified without updating downstream consumers like z-server ingestion and UI dashboards. This Skill provides a structured procedure to detect, update, and validate telemetry contract changes so emitters and consumers stay in lockstep. ## Core Features & Use Cases - Contract Surface Identification: Locates the stable surfaces that must not drift, including telemetry JSONL envelope shape, event names with required fields, and /api/health and /api/status payload shapes. - Lockstep Updates: Guides updating emitter and consumer code together, along with the smallest tests that enforce the contract. - Anti-Pattern Guardrails: Flags risky changes such as blindly renaming events without checking downstream consumers or bloating /api/status with deeply nested payloads. - Use Case: When adding a new field to a telemetry event consumed by z-server, use this Skill to find the relevant session docs, update both sides, add a contract test, and record the migration rationale. ## Quick Start Use the telemetry-contracts skill to check whether renaming this telemetry event will break the /api/status consumers and z-server ingestion.

Frequently Asked Questions about telemetry-contracts

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I prevent telemetry drift when renaming events?▼

Identify all downstream consumers such as z-server ingestion and UI dashboards before renaming any event. Update the emitter and consumers in lockstep, then add a targeted test that enforces the event name and required fields.

What telemetry contract surfaces need to stay stable?▼

Three surfaces must remain stable: the telemetry JSONL envelope shape, event names with their required fields, and the /api/health and /api/status payload shapes. Changes to any of these require coordinated updates and contract tests.

How do I add a new field to a telemetry event safely?▼

Start from the most recent telemetry session docs under docs/sessions/ to understand the current contract. Update the emitter and affected consumers together, add the smallest test enforcing the new shape, and record the rationale for the change.

Why is adding large nested objects to /api/status a problem?▼

Bloated payloads violate the compact telemetry contract and can break or slow downstream consumers like dashboards. Keep /api/status responses small and move detailed data to dedicated endpoints or event streams.

When should I escalate a telemetry contract change for research?▼

Escalate when a contract change affects multiple servers and needs a migration strategy, or when you need a formal schema and versioning plan. Single-server changes with clear consumers can be handled directly with lockstep updates and tests.