Telemetry
For teams using Codex to add analytics and observability

Codex Instrumentation Prompt

A focused prompt that asks Codex to instrument the rest of the product, verify events, and summarize coverage gaps.

Why this works
  • Captures user behavior, billing, onboarding, and operational signals.
  • Pairs implementation with verification so you know events are flowing.
  • Optimizes for future product questions, not just today's dashboard.

Agent prompt

Paste this into your coding agent

Replace YOUR_API_KEY after signup, then ask the agent to run the product flow and verify the first events.

agent prompt

Codex Instrumentation Prompt setup prompt

text
Instrument this project with structured logs using /skill.md.

Use this Telemetry API key: YOUR_API_KEY

Please:
1. Find the most important user-facing flows, background jobs, and AI/tooling workflows.
2. Add structured logging with pragmatic snake_case tables and fields.
3. Capture the key signals for each workflow, including status, latency, identifiers, and error context when relevant.
4. Send test events to Telemetry and verify that ingestion works.
5. Create a high-level dashboard with charts and tables that summarize the most important signals in this project.
6. Tell me what you instrumented, which tables you created, and which dashboard views I should review first.

Prefer small, composable events over giant payloads, and optimize for dashboards that humans can scan quickly.

Setup steps

  1. 1Generate or copy a Telemetry API key.
  2. 2Ask Codex to apply the prompt in your repository.
  3. 3Run the product flows that matter.
  4. 4Query Telemetry for the new events and fill remaining gaps.

Events to capture

page_viewedcode_snippet_copiedintegration_check_submittedbilling_portal_openedalert_createdresult_exported

Questions unlocked

  • Do users who copy setup prompts reach activation faster?
  • Which docs pages produce registrations?
  • Which product areas are used before checkout?

Next step

Create the API key your agent will use

The free plan is enough to run the prompt, send test events, and review the first dashboard.

Related pages