add-telemetry

Define telemetry event enums implementing the TelemetryEvent trait for Warp features.

64.1k|5.4k|Updated Jul 8, 2021
One-click install
npx skills add https://github.com/warpdotdev/warp --skill add-telemetry-warpdotdev
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: add-telemetry
Source: https://github.com/warpdotdev/warp/tree/main/.agents/skills/add-telemetry
Command: npx skills add https://github.com/warpdotdev/warp --skill add-telemetry-warpdotdev

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Instrument Warp features by providing a clear pattern for telemetry instrumentation to enable structured event tracking and observability across the codebase.

Core Features & Use Cases

  • Define a feature-specific telemetry enum that implements TelemetryEvent.
  • Implement the TelemetryEvent trait to provide name, payload, description, and enablement logic.
  • Register the telemetry event and emit events from application code using the provided macros.
  • Use cases include tracking feature usage, performance, and errors to inform product decisions.

Quick Start

Add a new telemetry event for your feature, implement the TelemetryEvent trait, register the event, and emit telemetry using send_telemetry_from_ctx!.

Frequently Asked Questions about add-telemetry

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

FAQPage Schema
How do I add telemetry events to track Rust feature usage?

To add telemetry events in Rust, define a feature-specific telemetry enum, implement the TelemetryEvent trait for structured payloads, register the event, and emit it using send_telemetry_from_ctx! macros.

What is the TelemetryEvent trait used for in observability?

The TelemetryEvent trait is used to produce structured payloads by implementing name, payload, description, and enablement logic methods for tracking feature usage, performance, and errors across modules.

How do I implement structured telemetry instrumentation across a codebase?

Structured telemetry instrumentation requires creating a telemetry enum, implementing the TelemetryEvent trait, setting optional enablement rules, registering the event, and emitting events with provided helpers.

Can I set conditional enablement rules for telemetry events?

Yes, you can optionally set enablement rules when implementing the TelemetryEvent trait to control when structured telemetry events are emitted across your application modules.

When do I need to define a feature-specific telemetry event enum?

You need to define a feature-specific telemetry event enum during development tasks where you must track feature usage, monitor performance, or log errors to inform observability and product decisions.

Does this telemetry instrumentation pattern work without external dependencies?

Yes, this telemetry instrumentation pattern operates without external dependencies, relying solely on defining enums, implementing the TelemetryEvent trait, and using provided macros for event registration and emission.