logging-best-practices

Documents best practices for Grove's Rust TUI debug record logging system.

8|2|Updated Feb 14, 2026
One-click install
npx skills add https://github.com/MichaelVessia/grove --skill logging-best-practices-michaelvessia
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: logging-best-practices
Source: https://github.com/MichaelVessia/grove/tree/main/.agents/skills/logging-best-practices
Command: npx skills add https://github.com/MichaelVessia/grove --skill logging-best-practices-michaelvessia

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill provides clear guidelines and best practices for effectively using Grove's structured NDJSON debug record system, ensuring comprehensive and actionable logs for debugging and analysis.

Core Features & Use Cases

  • Structured Logging: Learn how to add new events to the NDJSON debug record.
  • Event Design: Understand principles for wide, context-rich events with clear event/kind identifiers.
  • Data Capture: Discover how to include high-cardinality and high-dimensionality fields for post-hoc diagnosis.
  • Timing & Correlation: Implement best practices for measuring durations and using sequence numbers for event correlation.
  • Use Case: When developing a new feature that requires detailed logging, consult this Skill to ensure your new log events are designed correctly, capture all necessary context, and follow established patterns.

Quick Start

Use the logging-best-practices skill to understand how to add new events to the debug record system.

Frequently Asked Questions about logging-best-practices

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

FAQPage Schema
How do I add new events to a Rust TUI structured NDJSON debug record system?

To add new events to a Rust TUI structured NDJSON debug record, design wide events at boundaries with clear event/kind identifiers, rich data fields, and sequence numbers for correlation. Ensure zero cost when disabled.

What are the best practices for designing structured logging events in Rust?

Best practices for structured logging events in Rust include creating wide, context-rich events per boundary, using clear event/kind identifiers, and capturing high-cardinality, high-dimensionality fields for post-hoc diagnosis.

How does event correlation work with sequence numbers in debug logging?

Event correlation in debug logging uses sequence numbers to link related events together. This allows developers to trace specific actions across the NDJSON debug record during post-hoc analysis.

Does structured debug logging have a performance cost when disabled in Rust?

Structured debug logging in Rust should have zero cost when disabled. This ensures that instrumentation and telemetry events do not impact application performance when debug recording is turned off.

What is a wide event in the context of structured telemetry and instrumentation?

A wide event in structured telemetry is a context-rich log entry created at system boundaries. It captures high-dimensionality data fields, providing comprehensive context for debugging and post-hoc diagnosis.