logging-best-practices

Name: logging-best-practices
Rating: 71 (1 reviews)
Author: boristane

tessl install github:boristane/agent-skills --skill logging-best-practices

github.com/boristane/agent-skills

Logging best practices focused on wide events (canonical log lines) for powerful debugging and analytics

Review Score

71%

Validation Score

15/16

Implementation Score

65%

Activation Score

N/A

SKILL.md

Review

Evals

Generated

12 days ago

Warnings & errors only

Criteria	Score
description_trigger_hint	Description may be missing an explicit 'when to use' trigger hint (e.g., 'Use when...')

Overall Assessment

This is a solid logging skill with an excellent, actionable code example demonstrating the wide events pattern. The core principles are well-organized and the anti-patterns provide useful guardrails. However, there's redundancy between sections (anti-patterns restating principles), and the referenced rule files are mentioned without clear indication of their added value over the main content.

Suggestions

Remove the anti-patterns section or consolidate it into the core principles to reduce redundancy
Add a brief validation step showing how to verify logging is working (e.g., 'Test by checking your log aggregator for the expected fields')
Clarify what additional content exists in the referenced rules/*.md files to help readers decide whether to consult them

Dimension	Score	Reasoning
Conciseness	2/3	The content is reasonably efficient but includes some unnecessary explanation (e.g., 'also called canonical log lines', explaining what high cardinality means). The anti-patterns section largely restates what was already covered in core principles.
Actionability	3/3	Provides a complete, executable TypeScript example demonstrating the wide events pattern with proper try/catch/finally structure. The code is copy-paste ready and shows exactly how to implement the pattern.
Workflow Clarity	2/3	The 'When to Apply' section provides clear triggers, and the code example shows the workflow, but there are no explicit validation steps or checkpoints for verifying logging is working correctly. For a logging skill, some guidance on testing/validating log output would strengthen this.
Progressive Disclosure	2/3	References to rules files (wide-events.md, context.md, etc.) suggest good structure, but these are mentioned at the end without clear signaling of what additional value they provide. The main content could be tighter with more detail pushed to referenced files.

Something went wrong