code-add-observability

Add structured, leveled logging and error evidence to integration boundary code.

22|3|Updated Jul 28, 2024
One-click install
npx skills add https://github.com/webdevcody/go-mailing-list --skill code-add-observability
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: code-add-observability
Source: https://github.com/webdevcody/go-mailing-list/tree/main/.claude/skills/code-add-observability
Command: npx skills add https://github.com/webdevcody/go-mailing-list --skill code-add-observability

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill prevents silent integration failures by adding structured, leveled logs and typed error reporting exactly at system boundaries, so later fixes can rely on concrete evidence instead of guessing.

Core Features & Use Cases

  • Integration-boundary instrumentation: Adds logs around outbound HTTP, inbound webhooks/routes, IPC, spawn/exec, env injection, file writes, queues, and hook/MCP calls.
  • Logger discovery & conformity: Detects and conforms to the project’s existing logger; proposes a minimal zero-dependency fallback if none is found (without installing first).
  • Silent-failure protection: Replaces swallow patterns like empty catches and || true-style behavior with logged equivalents while preserving semantics.
  • Discoverability for /fix-bug: Ensures event names are greppable and documents where logs land so a later reactive skill can find the trail quickly.

Quick Start

Tell the AI which feature or integration you want to instrument, then ask it to wire up observability for its boundaries and verify that at least one boundary log event actually fires.

Frequently Asked Questions about code-add-observability

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

FAQPage Schema
How do I add structured logging to integration boundaries like outbound HTTP and IPC?

Structured logging at integration boundaries is added by instrumenting outbound HTTP, IPC, spawn/exec, and queue handoffs with leveled logs and typed error reporting. The Skill discovers your existing logger and injects recipe-driven event instrumentation directly into boundary code.

What is the best way to prevent silent failures from empty catch blocks in integration code?

Preventing silent failures from empty catch blocks involves replacing swallow patterns with logged equivalents while preserving original semantics. The Skill targets empty catches and `|| true`-style behavior, adding structured error evidence so failures leave a debuggable trail.

How do I instrument webhook routes and file writes for debuggability without adding new dependencies?

Instrumenting webhook routes and file writes without new dependencies is possible because the Skill conforms to your project's existing logger. If no logger is found, it proposes a minimal zero-dependency fallback without installing anything first.

Can I sweep my current branch diff and add observability to all system boundaries at once?

Sweeping a current branch diff for system boundaries is supported by the Skill. It enumerates inbound and outbound HTTP, IPC, spawn/exec, env injection, file writes, queues, hooks, and MCP tool handoffs, then applies recipe-driven instrumentation across all detected surfaces.

Why do my integration logs need greppable event names for debugging?

Greppable event names are needed so downstream debugging processes can quickly locate the evidence trail. The Skill documents where logs land and verifies at runtime that emitted event names are searchable, enabling a later reactive skill to find the trail reliably.

Does this observability instrumentation work with MCP tool handoffs and queue operations?

Observability instrumentation explicitly supports MCP tool handoffs and queue operations. The Skill targets these specific integration boundaries alongside HTTP, IPC, and file writes, adding structured leveled logs and typed error reporting to each surface.